Skip to main content
IBM Quantum Platform
Cette API REST est uniquement disponible pour les membres du On-Prem Plan qui l'ont activée dans leur environnement.

Travaux

Exécution d'un travail

Appeler une primitive d' Qiskit Runtime.

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.direct-access-job.create

Audit

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

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

Entrée

Paramètres de corps
Nom, type
Description
backend
Obligatoire
string

Nom du backend

Exemple: "ibm_rensselaer"
id
Obligatoire
string

Identifiant du poste. Recommandé pour être UUID

log_level
string

Niveau de journalisation du programme

Valeurs possibles: infodebugwarningerrorcritical
Valeur par défaut: warning
program_id
Obligatoire
string

Identifiant du programme

Exemple: "sampler"
storage
Obligatoire
object
timeout_secs
Obligatoire
integer

Temps (en secondes) après lequel la tâche doit expirer et être annulée. Il est basé sur le temps d'exécution du système (et non sur l'heure réelle). Le temps d'exécution du système correspond au temps que le système consacre au traitement de votre tâche.

Exemples de code
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":{}}'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
204Renvoyé lorsque la tâche a été soumise avec succès.
400Renvoyé lorsqu'une entrée non valide est reçue.
401Renvoyé lorsque l'authentification a échoué.
404Renvoyé lorsque le backend n'a pas été trouvé
408Renvoyé lorsque la requête a pris trop de temps à lire.
409Renvoyé lorsqu'un travail en double avec le même ID de travail a été soumis.
413Renvoyé lorsque le corps de la requête est trop volumineux.
422Renvoyé lorsque la validation de la requête a échoué. Le message d'erreur contient des détails sur l'erreur de validation spécifique.
423Le backend demandé est réservé et les tâches en dehors de la réservation ne peuvent pas être exécutées.
429Renvoyé lorsque la limite de tâches simultanées par backend a été atteinte. Réessayez plus tard, une fois que les tâches existantes seront terminées, et supprimez les tâches terminées pour en soumettre d'autres.
Réponses
Renvoyé lorsque la tâche a été soumise avec succès.

Obtenir des travaux

Récupère une liste de toutes les tâches soumises par le client authentifié actuel, classées par ordre croissant selon leur date de création.

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.direct-access-job.list

Audit

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

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

Entrée

Informations
Ce noeud final n'accepte aucun paramètre en entrée.
Exemples de code
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200Renvoyé lorsque les tâches ont été récupérées avec succès.
401Renvoyé lorsque l'authentification a échoué.
Réponses
{
  "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
      }
    }
  ]
}

Obtenir un emploi par ID

Récupère une seule tâche à l'aide de son identifiant unique pour le client actuellement authentifié.

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.direct-access-job.read

Audit

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

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

Entrée

Paramètres de chemin
Nom, type
Description
job-id
Obligatoire
string
Exemples de code
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
200Tâche récupérée avec succès.
401Renvoyé lorsque l'authentification a échoué.
404Aucune tâche trouvée pour l'ID fourni appartenant au client authentifié.
Réponses
{
  "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
  }
}

Supprimer un travail

Supprime une tâche si elle est terminée.

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.direct-access-job.delete

Audit

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

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

Entrée

Paramètres de chemin
Nom, type
Description
job-id
Obligatoire
string
Exemples de code
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
204Renvoyé lorsque la tâche a été supprimée avec succès.
401Renvoyé lorsque l'authentification a échoué.
404Renvoyé lorsque le travail n'est pas trouvé.
409Renvoyé lorsqu'une tâche n'est pas encore terminée et doit être annulée avant de pouvoir être supprimée.
Réponses
Renvoyé lorsque la tâche a été supprimée avec succès.

Annuler un travail

Annule une tâche si elle n'est pas encore terminée.

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.direct-access-job.cancel

Audit

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

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

Entrée

Paramètres de chemin
Nom, type
Description
job-id
Obligatoire
string
Exemples de code
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

Sortie

Codes d'état de la réponse HTTP
Code d'état
Description
204Renvoyé lorsque la demande d'annulation de tâche a été soumise avec succès.
401Renvoyé lorsque l'authentification a échoué.
404Renvoyé lorsque le travail n'est pas trouvé.
409Renvoyé lorsqu'une tâche est déjà terminée et ne peut être annulée.
500Renvoyé lorsqu'une erreur interne du serveur se produit.
Réponses
Renvoyé lorsque la demande d'annulation de tâche a été soumise avec succès.
Cette page a-t-elle été utile ?
Signaler un bogue, une coquille ou proposer du contenu sur GitHub.