Skip to main content
IBM Quantum Platform
Diese REST-API steht nur jenen Mitgliedern des On-Prem-Plans zur Verfügung, die sie in ihrer Umgebung aktiviert haben.

Jobs

Job ausführen

Rufen Sie eine Primitive „ Qiskit Runtime “ auf.

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

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

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

Eingabe

Hauptteilparameter
Name, Typ
Beschreibung
backend
Erforderlich
string

Name des Backends

Beispiel: "ibm_rensselaer"
id
Erforderlich
string

Job-Kennung. Empfohlen als UUID

log_level
string

Protokollierungsstufe des Programms

Gültige Werte: infodebugwarningerrorcritical
Standardwert: warning
program_id
Erforderlich
string

ID des Programms

Beispiel: "sampler"
storage
Erforderlich
object
timeout_secs
Erforderlich
integer

Zeit (in Sekunden), nach der der Auftrag zeitlich begrenzt und abgebrochen werden soll. Es basiert auf der Systemausführungszeit (nicht auf der Wanduhrzeit). Die Systemausführungszeit ist die Zeit, die das System für die Verarbeitung Ihres Auftrags benötigt.

Codebeispiele
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":{}}'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204Wird zurückgegeben, wenn der Auftrag erfolgreich übermittelt wurde.
400Wird zurückgegeben, wenn eine ungültige Eingabe empfangen wird.
401Wird zurückgegeben, wenn die Authentifizierung fehlgeschlagen ist.
404Wurde zurückgegeben, als das Backend nicht gefunden wurde
408Wurde zurückgegeben, als das Lesen der Anfrage zu lange dauerte.
409Wird zurückgegeben, wenn ein doppelter Auftrag mit derselben Auftrags-ID eingereicht wurde.
413Wird zurückgegeben, wenn der Request-Body zu groß ist.
422Wird zurückgegeben, wenn die Validierung der Anfrage fehlgeschlagen ist. Die Fehlermeldung enthält Details zum spezifischen Validierungsfehler.
423Das angeforderte Backend ist reserviert, und Aufträge außerhalb der Reservierung können nicht ausgeführt werden.
429Wird zurückgegeben, wenn das Limit für gleichzeitige Backend-Jobs erreicht ist. Versuchen Sie es später erneut, sobald die bestehenden Aufträge beendet sind, und löschen Sie beendete Aufträge, um weitere zu übermitteln.
Antworten
Wird zurückgegeben, wenn der Auftrag erfolgreich übermittelt wurde.

Jobs abrufen

Ruft eine Liste aller vom aktuell authentifizierten Client übermittelten Aufträge ab, sortiert nach Erstellungszeit in aufsteigender Reihenfolge.

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

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

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

Eingabe

Informationen
Dieser Endpunkt akzeptiert keine Eingaben.
Codebeispiele
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200Wird zurückgegeben, wenn Jobs erfolgreich abgerufen wurden.
401Wird zurückgegeben, wenn die Authentifizierung fehlgeschlagen ist.
Antworten
{
  "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
      }
    }
  ]
}

Stelle anhand der ID finden

Ruft einen einzelnen Auftrag anhand seiner eindeutigen Kennung für den aktuell authentifizierten Client ab.

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

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

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

Eingabe

Pfadparameter
Name, Typ
Beschreibung
job-id
Erforderlich
string
Codebeispiele
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
200Auftrag erfolgreich abgerufen.
401Wird zurückgegeben, wenn die Authentifizierung fehlgeschlagen ist.
404Für die angegebene ID des authentifizierten Clients wurde kein Auftrag gefunden.
Antworten
{
  "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
  }
}

Job löschen

Löscht einen Auftrag, wenn er beendet wurde.

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

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

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

Eingabe

Pfadparameter
Name, Typ
Beschreibung
job-id
Erforderlich
string
Codebeispiele
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204Wird zurückgegeben, wenn der Auftrag erfolgreich gelöscht wurde.
401Wird zurückgegeben, wenn die Authentifizierung fehlgeschlagen ist.
404Wird zurückgegeben, wenn der Auftrag nicht gefunden wird.
409Wird zurückgegeben, wenn ein Auftrag noch nicht beendet ist und vor dem Löschen abgebrochen werden muss.
Antworten
Wird zurückgegeben, wenn der Auftrag erfolgreich gelöscht wurde.

Job abbrechen

Bricht einen Auftrag ab, wenn dieser noch nicht beendet ist.

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

Protokollierung

Der Aufruf dieser Methode generiert die folgenden Überwachungsereignisse.

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

Eingabe

Pfadparameter
Name, Typ
Beschreibung
job-id
Erforderlich
string
Codebeispiele
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

Ausgabe

Code für den Status von HTTP-Antworten
Statuscode
Beschreibung
204Wird zurückgegeben, wenn die Anforderung zum Abbrechen des Auftrags erfolgreich übermittelt wurde.
401Wird zurückgegeben, wenn die Authentifizierung fehlgeschlagen ist.
404Wird zurückgegeben, wenn der Auftrag nicht gefunden wird.
409Wird zurückgegeben, wenn ein Auftrag bereits beendet wurde und nicht mehr abgebrochen werden kann.
500Wird zurückgegeben, wenn ein interner Serverfehler auftritt.
Antworten
Wird zurückgegeben, wenn die Anforderung zum Abbrechen des Auftrags erfolgreich übermittelt wurde.
War diese Seite hilfreich?
Melden Sie auf GitHub einen Fehler, einen Tippfehler oder fordern Sie Inhalte an.