メインコンテンツまでスキップ

ジョブ API エンドポイント

1 ジョブ作成および実行エンドポイント

  • 目的: 指定された関数を使用してジョブを作成し、実行します。

  • メソッド: POST

  • パラメータ:

    • function_id: ジョブで使用する関数の ID。
    • provider: ジョブのプロバイダー(AWS、IBM など)。
    • device: ジョブを実行する特定のデバイス(量子コンピュータ、GPU など)。
    • shots: ジョブを実行する回数(ショット数)。
  • レスポンス:
    サーバーは 202 Accepted ステータスを返し、ジョブの追跡が可能になるジョブ ID を生成します。

2 ジョブステータス確認エンドポイント

  • 目的: 実行中のジョブのステータスを確認します。

  • パラメータ:

    • job_id: ステータスを追跡するジョブの ID。
  • レスポンス:
    ジョブのステータス(例: "Running"、"Completed"、"Failed")およびジョブの進行状況に関する追加情報が返されます。

3 ジョブ結果およびログ取得エンドポイント

  • 目的: 完了したジョブの結果とログを取得します。

  • メソッド: GET

  • パラメータ:

    • job_id: 結果とログを取得するジョブの ID。
  • レスポンス:
    ジョブの結果(出力データ)およびデバッグまたは分析のためのログが返されます。

4 ジョブのキャンセルまたは再実行エンドポイント

  • 目的: ジョブをキャンセルするか、再実行します。

  • メソッド:

    • キャンセル: DELETE
    • 再実行: POST
  • パラメータ:

    • job_id: キャンセルまたは再実行するジョブの ID。
  • レスポンス:
    キャンセルまたは再実行が成功すると 200 OK ステータスが返され、更新されたジョブのステータスが含まれます。