Skip to main content
IBM Quantum Platform

Sessions

Create a session

Create a session

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.session.create

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.session.create

Eingabe

Hauptteilparameter
Name, Typ
Beschreibung
max_ttl
integer

The maximum time (in seconds) for the session to run, subject to plan limits.

Standardwert: 28800
Mindestwert: 1
Maximalwert: 2147483647
mode
string

Execution mode to run the session in

Gültige Werte: batchdedicated
backend
string

Backend name

backend_name
string

Backend name (fallback)

Codebeispiele
POST
/v1/sessions

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen 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'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200Ok
400Bad Request
401Unauthorized
500Internal error
Antworten
{
  "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": 2,
  "usage": {
    "value": 1,
    "unit": "resource_units",
    "details": [
      {
        "value": 1,
        "unit": "resource_units",
        "metric": {
          "id": "example",
          "value": 1
        }
      }
    ]
  }
}

Get a session

Get a session

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.session.read

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.session.read

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

Job Session ID

Codebeispiele
GET
/v1/sessions/{id}

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen 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'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200OK
401Unauthorized
404Not Found
500Internal error
Antworten
{
  "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": 2,
  "usage": {
    "value": 1,
    "unit": "resource_units",
    "details": [
      {
        "value": 1,
        "unit": "resource_units",
        "metric": {
          "id": "example",
          "value": 1
        }
      }
    ]
  }
}

Update a session

Update a session

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.session.update

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.session.update

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

Job Session ID

Hauptteilparameter
Name, Typ
Beschreibung
accepting_jobs
Erforderlich
boolean

If true, the session is actively accepting new jobs to be queued. If false, jobs will be rejected on create and the session will be immediately closed when there are no more jobs to run in the session.

Codebeispiele
PATCH
/v1/sessions/{id}

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen 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}'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204Successfully updated session
401Unauthorized
404Not Found
500Internal error
Antworten
Successfully updated session

Close job session

Closes the runtime session. The session stops accepting new jobs and queued jobs will not run. Existing running jobs will run to completion. This is analogous to the cancel() function in Qiskit.

Berechtigung

Um diese Methode aufrufen zu können, muss Ihnen mindestens eine IAM-Zugriffsrolle zugewiesen sein, die die folgenden Aktionen einschließt. Sie können Ihren Zugriff prüfen durch Aufrufen von Users > User > Access

  • quantum-computing.session.update

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

  • quantum-computing.session.update

Eingabe

Pfadparameter
Name, Typ
Beschreibung
id
Erforderlich
string

Session Id

Codebeispiele
DELETE
/v1/sessions/{id}/close

Wenn sich Ihre Instanz in der Region „eu-de“ befindet, verwenden Sie stattdessen diesen 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'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204Successfully closed runtime session
Antworten
Successfully closed runtime session
War diese Seite hilfreich?
Melden Sie auf GitHub einen Fehler, einen Tippfehler oder fordern Sie Inhalte an.