Skip to main content
IBM Quantum Platform
このREST APIは、環境で有効化されているOn-Prem Planメンバーのみが利用可能です。

ジョブ

ジョブの実行

Qiskit Runtime プリミティブを呼び出す。

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

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

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

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

入力

本文パラメーター
名前、タイプ
説明
backend
必須
string

バックエンド名

例: "ibm_rensselaer"
id
必須
string

ジョブ識別子。 UUIDが推奨されます

log_level
string

プログラムのログレベル

使用可能な値: infodebugwarningerrorcritical
デフォルト値: warning
program_id
必須
string

プログラムのID

例: "sampler"
storage
必須
object
timeout_secs
必須
integer

ジョブがタイムアウトしてキャンセルされるまでの時間（秒単位）。 システム実行時間（壁時計時間ではない）に基づいています。 システム実行時間とは、システムがお客様のジョブ処理に専念する時間の量です。

コード・サンプル
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":{}}'

出力

HTTP応答状況コード
状況コード
説明
204ジョブが正常に送信されたときに返されます。
400無効な入力が受信された場合に返されます。
401認証に失敗したため返却されました。
404バックエンドが見つからなかった場合に返される
408リクエストの読み取りに時間がかかりすぎたため返却されました。
409同じジョブIDを持つ重複ジョブが送信された場合に返されます。
413リクエスト本文が大きすぎる場合に返されます。
422リクエストの検証に失敗したときに返されます。 エラーメッセージには、特定の検証エラーに関する詳細が含まれています。
423リクエストされたバックエンドは予約済みであり、予約範囲外のジョブは実行できません。
429バックエンドの同時ジョブ制限に達したときに返されます。 既存のジョブが終了したら、再度試行してください。終了したジョブを削除して、さらにジョブを送信してください。
応答
ジョブが正常に送信されたときに返されます。

ジョブの取得

現在の認証済みクライアントによって送信されたすべてのジョブのリストを取得します。作成時刻の昇順で並べ替えられます。

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

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

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

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

入力

情報
このエンドポイントは入力を受け付けません。
コード・サンプル
GET
/v1/jobs
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs' \
  -H 'Accept: application/json'

出力

HTTP応答状況コード
状況コード
説明
200ジョブが正常に取得されたときに返されます。
401認証に失敗したため返却されました。
応答
{
  "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
      }
    }
  ]
}

IDで求人を探す

現在の認証済みクライアントに対して、一意の識別子で単一のジョブを取得します。

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

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

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

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

入力

パス・パラメーター
名前、タイプ
説明
job-id
必須
string
コード・サンプル
GET
/v1/jobs/{job-id}
curl -X GET \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

出力

HTTP応答状況コード
状況コード
説明
200ジョブが正常に取得されました。
401認証に失敗したため返却されました。
404認証済みクライアントに属する指定されたIDに対応するジョブが見つかりませんでした。
応答
{
  "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
  }
}

ジョブの削除

ジョブが終了している場合、それを削除します。

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

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

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

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

入力

パス・パラメーター
名前、タイプ
説明
job-id
必須
string
コード・サンプル
DELETE
/v1/jobs/{job-id}
curl -X DELETE \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}' \
  -H 'Accept: application/json'

出力

HTTP応答状況コード
状況コード
説明
204ジョブが正常に削除されたときに返されます。
401認証に失敗したため返却されました。
404ジョブが見つからない場合に返されます。
409ジョブがまだ終了しておらず、削除する前にキャンセルする必要がある場合に返されます。
応答
ジョブが正常に削除されたときに返されます。

ジョブをキャンセルします

ジョブがまだ終了していない場合、それをキャンセルします。

許可

このメソッドを呼び出すには、以下のアクションを含む1つ以上のIAMアクセス・ロールが割り当てられている必要があります。 アクセス状況を確認するには、次に移動してください。 Users > User > Access

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

監査

このメソッドを呼び出すと、以下の監査イベントが生成されます。

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

入力

パス・パラメーター
名前、タイプ
説明
job-id
必須
string
コード・サンプル
POST
/v1/jobs/{job-id}/cancel
curl -X POST \
  '<YOUR_QSA_URL>/v1/jobs/{job-id}/cancel' \
  -H 'Accept: application/json'

出力

HTTP応答状況コード
状況コード
説明
204ジョブキャンセル要求が正常に送信されたときに返されます。
401認証に失敗したため返却されました。
404ジョブが見つからない場合に返されます。
409ジョブが既に終了しており、キャンセルできない場合に返されます。
500内部サーバーエラーが発生した場合に返されます。
応答
ジョブキャンセル要求が正常に送信されたときに返されます。
このページは役に立ちましたか？
バグや誤字の報告、またはコンテンツの要求はGitHubで行ってください。