Skip to main content
IBM Quantum Platform

Sessions

Créer une session

Créer une session

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

  • quantum-computing.session.create

Audit

L'appel de cette méthode génère les événements d'audit suivants.

  • quantum-computing.session.create

Entrée

Paramètres de corps
Nom, type
Description
max_ttl
integer

Durée maximale (en secondes) d'exécution de la session, sous réserve des limites du plan.

Valeur par défaut: 28800
Valeur minimale: 1
Valeur maximale: 2147483647
mode
string

Mode d'exécution de la session

Valeurs possibles: batchdedicated
backend
string

Nom du backend

backend_name
string

Nom du backend (fallback)

Exemples de code
POST
/v1/sessions

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200OK
400Demande incorrecte
401Non autorisé
500Erreur interne
Réponses
{
  "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
}

Obtenir une session

Obtenir une session

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

  • quantum-computing.session.read

Audit

L'appel de cette méthode génère les événements d'audit suivants.

  • quantum-computing.session.read

Entrée

Paramètres de chemin
Nom, type
Description
id
Obligatoire
string

ID de la session de travail

Exemples de code
GET
/v1/sessions/{id}

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200bouton OK
401Non autorisé
404Introuvable
500Erreur interne
Réponses
{
  "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
}

Mise à jour d'une session

Mise à jour d'une session

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

  • quantum-computing.session.update

Audit

L'appel de cette méthode génère les événements d'audit suivants.

  • quantum-computing.session.update

Entrée

Paramètres de chemin
Nom, type
Description
id
Obligatoire
string

ID de la session de travail

Paramètres de corps
Nom, type
Description
accepting_jobs
Obligatoire
boolean

Si vrai, la session accepte activement de nouveaux travaux à mettre en file d'attente. Si elle est fausse, les travaux seront rejetés à la création et la session sera immédiatement fermée lorsqu'il n'y aura plus de travaux à exécuter dans la session.

Exemples de code
PATCH
/v1/sessions/{id}

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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}'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
204Mise à jour réussie de la session
401Non autorisé
404Introuvable
500Erreur interne
Réponses
Mise à jour réussie de la session

Fermer la session de travail

Ferme la session d'exécution. La session n'accepte plus de nouveaux travaux et les travaux en file d'attente ne sont pas exécutés. Les travaux en cours seront exécutés jusqu'à leur terme. Cette fonction est analogue à la fonction cancel() de Qiskit.

Autorisation

Pour appeler cette méthode, vous devez vous voir attribuer un ou plusieurs rôles d'accès IAM incluant les actions suivantes. Vous pouvez vérifier votre accès en vous rendant sur Users > User > Access

  • quantum-computing.session.update

Audit

L'appel de cette méthode génère les événements d'audit suivants.

  • quantum-computing.session.update

Entrée

Paramètres de chemin
Nom, type
Description
id
Obligatoire
string

ID session

Exemples de code
DELETE
/v1/sessions/{id}/close

Si votre instance se trouve dans la région « eu-de », utilisez plutôt ce lien : 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'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
204Fermeture réussie de la session d'exécution
Réponses
Fermeture réussie de la session d'exécution
Cette page a-t-elle été utile ?
Signaler un bogue, une coquille ou proposer du contenu sur GitHub.