Skip to main content
IBM Quantum Platform

Sessioni

Creare una sessione

Creare una sessione

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.session.create

Verifica

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

  • quantum-computing.session.create

Input

Parametri del corpo
Nome, tipo
Descrizione
max_ttl
integer

Il tempo massimo (in secondi) di esecuzione della sessione, soggetto ai limiti del piano.

Valore predefinito: 28800
Valore minimo: 1
Valore massimo: 2147483647
mode
string

Modalità di esecuzione in cui eseguire la sessione

Valori possibili: batchdedicated
backend
string

Nome del backend

backend_name
string

Nome del backend (fallback)

Esempi di codice
POST
/v1/sessions

Se la tua istanza si trova nella regione eu-de, utilizza invece questo link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions

curl -X POST \
  'https://quantum.cloud.ibm.com/api/v1/sessions' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
200OK
400Richiesta non valida
401Non autorizzato
500Errore interno
Risposte
{
  "id": "example",
  "backend_name": "example",
  "started_at": "example",
  "activated_at": "example",
  "closed_at": "example",
  "last_job_started": "example",
  "last_job_completed": "example",
  "interactive_ttl": 1,
  "max_ttl": 1,
  "active_ttl": 1,
  "state": "open",
  "state_reason": "example",
  "accepting_jobs": true,
  "mode": "batch",
  "timestamps": [
    {
      "status": "open",
      "timestamp": "example"
    }
  ],
  "user_id": "example",
  "elapsed_time": 1.432
}

Ottenere una sessione

Ottenere una sessione

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.session.read

Verifica

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

  • quantum-computing.session.read

Input

Parametri del percorso
Nome, tipo
Descrizione
id
Obbligatorio
string

ID sessione lavoro

Esempi di codice
GET
/v1/sessions/{id}

Se la tua istanza si trova nella regione eu-de, utilizza invece questo link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/sessions/{id}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
200Accettabilmente
401Non autorizzato
404Non trovato
500Errore interno
Risposte
{
  "id": "example",
  "backend_name": "example",
  "started_at": "example",
  "activated_at": "example",
  "closed_at": "example",
  "last_job_started": "example",
  "last_job_completed": "example",
  "interactive_ttl": 1,
  "max_ttl": 1,
  "active_ttl": 1,
  "state": "open",
  "state_reason": "example",
  "accepting_jobs": true,
  "mode": "batch",
  "timestamps": [
    {
      "status": "open",
      "timestamp": "example"
    }
  ],
  "user_id": "example",
  "elapsed_time": 1.432
}

Aggiornare una sessione

Aggiornare una sessione

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.session.update

Verifica

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

  • quantum-computing.session.update

Input

Parametri del percorso
Nome, tipo
Descrizione
id
Obbligatorio
string

ID sessione lavoro

Parametri del corpo
Nome, tipo
Descrizione
accepting_jobs
Obbligatorio
boolean

Se è vero, la sessione sta accettando attivamente nuovi lavori da accodare. Se false, i lavori verranno rifiutati alla creazione e la sessione verrà immediatamente chiusa quando non ci saranno più lavori da eseguire nella sessione.

Esempi di codice
PATCH
/v1/sessions/{id}

Se la tua istanza si trova nella regione eu-de, utilizza invece questo link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}

curl -X PATCH \
  'https://quantum.cloud.ibm.com/api/v1/sessions/{id}' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01' \
  -H 'Content-Type: application/json' \
  -d '{"accepting_jobs":true}'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
204Sessione aggiornata con successo
401Non autorizzato
404Non trovato
500Errore interno
Risposte
Sessione aggiornata con successo

Chiudere la sessione di lavoro

Chiude la sessione di runtime. La sessione smette di accettare nuovi lavori e i lavori in coda non vengono eseguiti. I lavori in corso verranno eseguiti fino al completamento. È analoga alla funzione cancel() di Qiskit.

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.session.update

Verifica

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

  • quantum-computing.session.update

Input

Parametri del percorso
Nome, tipo
Descrizione
id
Obbligatorio
string

ID sessione

Esempi di codice
DELETE
/v1/sessions/{id}/close

Se la tua istanza si trova nella regione eu-de, utilizza invece questo link: URL: https://eu-de.quantum.cloud.ibm.com/api/v1/sessions/{id}/close

curl -X DELETE \
  'https://quantum.cloud.ibm.com/api/v1/sessions/{id}/close' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2024-01-01'

Output

HTTP Codici di stato della risposta
Codice di stato
Descrizione
204Sessione di runtime chiusa con successo
Risposte
Sessione di runtime chiusa con successo
Questa pagina è stata utile?
Segnala un bug, un errore di battitura o richiedi contenuti su GitHub.