Skip to main content
IBM Quantum Platform

セッション

セッションの作成

セッションの作成

許可

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

  • quantum-computing.session.create

監査

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

  • quantum-computing.session.create

入力

本文パラメーター
名前、タイプ
説明
max_ttl
integer

セッションが実行される最大時間（秒）（プランの制限に従う）。

デフォルト値: 28800
最小値:: 1
最大値:: 2147483647
mode
string

セッションを実行するモード

使用可能な値: batchdedicated
backend
string

バックエンド名

backend_name
string

バックエンド名（フォールバック）

コード・サンプル
POST
/v1/sessions

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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: 2026-04-15'

出力

HTTP応答状況コード
状況コード
説明
200OK
400誤った要求
401認証されていません
500内部エラー
応答
{
  "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
}

セッションを受ける

セッションを受ける

許可

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

  • quantum-computing.session.read

監査

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

  • quantum-computing.session.read

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

ジョブ・セッションID

コード・サンプル
GET
/v1/sessions/{id}

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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: 2026-04-15'

出力

HTTP応答状況コード
状況コード
説明
200終了
401認証されていません
404未検出
500内部エラー
応答
{
  "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
}

セッションの更新

セッションの更新

許可

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

  • quantum-computing.session.update

監査

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

  • quantum-computing.session.update

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

ジョブ・セッションID

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

もしtrueなら、セッションはキューに入れられる新しいジョブを積極的に受け入れている。 falseの場合、ジョブは作成時に拒否され、セッション内で実行するジョブがなくなるとセッションは直ちに閉じられます。

コード・サンプル
PATCH
/v1/sessions/{id}

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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: 2026-04-15' \
  -H 'Content-Type: application/json' \
  -d '{"accepting_jobs":true}'

出力

HTTP応答状況コード
状況コード
説明
204セッションの更新に成功
401認証されていません
404未検出
500内部エラー
応答
セッションの更新に成功

ジョブ・セッションを閉じる

ランタイム・セッションを閉じる。 セッションは新しいジョブの受け付けを停止し、キューに入れられたジョブは実行されません。 既存の実行中のジョブは完了まで実行される。 これはQiskitの cancel() 関数に似ている。

許可

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

  • quantum-computing.session.update

監査

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

  • quantum-computing.session.update

入力

パス・パラメーター
名前、タイプ
説明
id
必須
string

セッションID

コード・サンプル
DELETE
/v1/sessions/{id}/close

インスタンスが eu-de リージョンにある場合は、代わりにこちらの 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: 2026-04-15'

出力

HTTP応答状況コード
状況コード
説明
204ランタイムセッションのクローズに成功
応答
ランタイムセッションのクローズに成功
このページは役に立ちましたか？
バグや誤字の報告、またはコンテンツの要求はGitHubで行ってください。