Skip to main content
IBM Quantum Platform
Questa API REST è disponibile solo per i membri del Piano On-Prem che l'hanno abilitata nel proprio ambiente.

Lavori

Esegui un lavoro

Richiamare una primitiva dell' Qiskit Runtime.

Autorizzazione

Per richiamare questo metodo, è necessario disporre di uno o più ruoli di accesso IAM che includano le seguenti azioni. È possibile verificare il proprio accesso andando su Users > User > Access

  • quantum-computing.direct-access-job.create

Verifica

La chiamata di questo metodo genera i seguenti eventi di auditing.

  • quantum-computing.direct-access-job.create

Input

Parametri del corpo
Nome, tipo
Descrizione
backend
Obbligatorio
string

Nome del backend

Esempio: "ibm_rensselaer"
id
Obbligatorio
string

Identificativo del lavoro. Consigliato per essere UUID

log_level
string

Livello di registrazione del programma

Valori possibili: infodebugwarningerrorcritical
Valore predefinito: warning
program_id
Obbligatorio
string

ID del programma

Esempio: "sampler"
storage
Obbligatorio
object
timeout_secs
Obbligatorio
integer

Tempo (in secondi) dopo il quale il processo dovrebbe scadere ed essere annullato. Si basa sul tempo di esecuzione del sistema (non sul tempo reale). Il tempo di esecuzione del sistema è il tempo che il sistema dedica all'elaborazione del tuo lavoro.

Esempi di codice
POST
/v1/jobs
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{"id":"example","program_id":"sampler","backend":"ibm_rensselaer","timeout_secs":1,"storage":{}}'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
204Restituito quando il lavoro è stato inviato con successo.
400Restituito quando viene ricevuto un input non valido.
401Restituito quando l'autenticazione non è riuscita.
404Restituito quando il backend non è stato trovato
408Restituito quando la richiesta ha richiesto troppo tempo per essere letta.
409Restituito quando è stato inviato un lavoro duplicato con lo stesso ID lavoro.
413Restituito quando il corpo della richiesta è troppo grande.
422Restituito quando la convalida della richiesta non è riuscita. Il messaggio di errore contiene dettagli sull'errore di convalida specifico.
423Il backend richiesto è riservato e non è possibile eseguire lavori al di fuori della prenotazione.
429Restituito quando è stato raggiunto il limite di lavori simultanei per backend. Riprova più tardi, una volta terminati i lavori esistenti, ed elimina i lavori terminati per inviarne altri.
Risposte
Restituito quando il lavoro è stato inviato con successo.

Richiama lavori

Recupera un elenco di tutti i lavori inviati dal client autenticato corrente, ordinati in ordine crescente in base alla data di creazione.

Autorizzazione

Per richiamare questo metodo, è necessario disporre di uno o più ruoli di accesso IAM che includano le seguenti azioni. È possibile verificare il proprio accesso andando su Users > User > Access

  • quantum-computing.direct-access-job.list

Verifica

La chiamata di questo metodo genera i seguenti eventi di auditing.

  • quantum-computing.direct-access-job.list

Input

Informazioni
Questo endpoint non accetta alcun input.
Esempi di codice
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
200Restituito quando i lavori sono stati recuperati correttamente.
401Restituito quando l'autenticazione non è riuscita.
Risposte
{
  "jobs": [
    {
      "backend": "ibm_rensselaer",
      "created_time": "example",
      "end_time": "example",
      "id": "example",
      "log_level": "info",
      "metrics": {
        "circuits_execution_time_ns": 1,
        "timestamps": {
          "created": "example",
          "finished": "example"
        }
      },
      "program_id": "sampler",
      "reason_code": 1,
      "reason_message": "example",
      "reason_solution": "example",
      "status": "Running",
      "storage": {
        "input": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        },
        "logs": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        },
        "results": {
          "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
          "object_name": "example",
          "presigned_url": "example",
          "region": "us-east",
          "region_type": "regional",
          "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
          "type": "s3_compatible"
        }
      },
      "timeout_secs": 1,
      "usage": {
        "quantum_nanoseconds": 1
      }
    }
  ]
}

Ottieni lavoro tramite ID

Recupera un singolo lavoro tramite il suo identificatore univoco per il client attualmente autenticato.

Autorizzazione

Per richiamare questo metodo, è necessario disporre di uno o più ruoli di accesso IAM che includano le seguenti azioni. È possibile verificare il proprio accesso andando su Users > User > Access

  • quantum-computing.direct-access-job.read

Verifica

La chiamata di questo metodo genera i seguenti eventi di auditing.

  • quantum-computing.direct-access-job.read

Input

Parametri del percorso
Nome, tipo
Descrizione
job-id
Obbligatorio
string
Esempi di codice
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
200Lavoro recuperato con successo.
401Restituito quando l'autenticazione non è riuscita.
404Nessun lavoro trovato per l'ID fornito appartenente al client autenticato.
Risposte
{
  "backend": "ibm_rensselaer",
  "created_time": "example",
  "end_time": "example",
  "id": "example",
  "log_level": "info",
  "metrics": {
    "circuits_execution_time_ns": 1,
    "timestamps": {
      "created": "example",
      "finished": "example"
    }
  },
  "program_id": "sampler",
  "reason_code": 1,
  "reason_message": "example",
  "reason_solution": "example",
  "status": "Running",
  "storage": {
    "input": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    },
    "logs": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    },
    "results": {
      "bucket_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/abc123:abc123:bucket:my-bucket",
      "object_name": "example",
      "presigned_url": "example",
      "region": "us-east",
      "region_type": "regional",
      "runtime_instance_crn": "crn:v1:bluemix:public:quantum-computing:us-east:a/abc123:abc123::",
      "type": "s3_compatible"
    }
  },
  "timeout_secs": 1,
  "usage": {
    "quantum_nanoseconds": 1
  }
}

Cancella un lavoro

Elimina un lavoro se è stato terminato.

Autorizzazione

Per richiamare questo metodo, è necessario disporre di uno o più ruoli di accesso IAM che includano le seguenti azioni. È possibile verificare il proprio accesso andando su Users > User > Access

  • quantum-computing.direct-access-job.delete

Verifica

La chiamata di questo metodo genera i seguenti eventi di auditing.

  • quantum-computing.direct-access-job.delete

Input

Parametri del percorso
Nome, tipo
Descrizione
job-id
Obbligatorio
string
Esempi di codice
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
204Restituito quando il lavoro è stato eliminato correttamente.
401Restituito quando l'autenticazione non è riuscita.
404Restituito quando il lavoro non viene trovato.
409Restituito quando un processo non è ancora terminato e deve essere annullato prima di poter essere eliminato.
Risposte
Restituito quando il lavoro è stato eliminato correttamente.

Annulla un lavoro

Annulla un lavoro se non è ancora terminato.

Autorizzazione

Per richiamare questo metodo, è necessario disporre di uno o più ruoli di accesso IAM che includano le seguenti azioni. È possibile verificare il proprio accesso andando su Users > User > Access

  • quantum-computing.direct-access-job.cancel

Verifica

La chiamata di questo metodo genera i seguenti eventi di auditing.

  • quantum-computing.direct-access-job.cancel

Input

Parametri del percorso
Nome, tipo
Descrizione
job-id
Obbligatorio
string
Esempi di codice
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
204Restituito quando la richiesta di annullamento del lavoro è stata inviata con successo.
401Restituito quando l'autenticazione non è riuscita.
404Restituito quando il lavoro non viene trovato.
409Restituito quando un processo è già terminato e non può essere annullato.
500Restituito quando si verifica un errore interno del server.
Risposte
Restituito quando la richiesta di annullamento del lavoro è stata inviata con successo.
Questa pagina è stata utile?
Segnala un bug, un errore di battitura o richiedi contenuti su GitHub.