インスタンス

現在のインスタンスの詳細を取得する

リクエストヘッダからCRNを使用して、現在ログインしているインスタンスの詳細を返します。

許可

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

quantum-computing.instance.read

監査

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

quantum-computing.instance.read

入力

情報
このエンドポイントは入力を受け付けません。

コード・サンプル

GET

/v1/instance

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instance

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instance' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instance

import requests

response = requests.request(
    "GET",
    "https://quantum.cloud.ibm.com/api/v1/instance",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2026-04-15",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

出力

HTTP応答状況コード
状況コード	説明
200	終了
401	認証されていません
403	禁止
404	未検出

応答

状況コード

{
  "backends": [
    "ibm_backend"
  ],
  "instance_limit": 60.7,
  "instance_limit_seconds": "61",
  "plan_id": "flex-plan-id-1",
  "usage_allocation_seconds": "200"
}

{
  "type": "object",
  "description": "インスタンス",
  "properties": {
    "backends": {
      "type": "array",
      "description": "サービスインスタンスに関連するバックエンドシステムまたはクラスタのリスト",
      "items": {
        "type": "string",
        "pattern": "^.*$",
        "minLength": 1,
        "maxLength": 128,
        "nullable": false
      },
      "minItems": 0,
      "maxItems": 100
    },
    "instance_limit": {
      "type": "number",
      "format": "double",
      "description": "インスタンスのリミットを秒単位で表す",
      "deprecated": true
    },
    "instance_limit_seconds": {
      "type": "string",
      "description": "このインスタンスで実行できるリソース時間の最大数を指定する"
    },
    "plan_id": {
      "type": "string",
      "description": "グローバルカタログで定義されたインスタンスに関連するサービスプランの識別子",
      "pattern": "^.*$",
      "minLength": 1,
      "maxLength": 128
    },
    "usage_allocation_seconds": {
      "type": "string",
      "description": "インスタンスで許容される使用割り当ての最大合計。"
    }
  }
}

インスタンス構成の取得

リクエストヘッダから CRN を使用して、指定されたインスタンスのコンフィギュレーション (例: 秒単位のインスタンス制限) を返します。

許可

quantum-computing.instance.configuration.read

監査

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

quantum-computing.instance.configuration.read

入力

情報
このエンドポイントは入力を受け付けません。

コード・サンプル

GET

/v1/instances/configuration

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instances/configuration' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

import requests

response = requests.request(
    "GET",
    "https://quantum.cloud.ibm.com/api/v1/instances/configuration",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2026-04-15",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

出力

HTTP応答状況コード
状況コード	説明
200	終了
401	認証されていません
403	禁止
404	未検出

応答

状況コード

{
  "instance_limit": 123456
}

{
  "type": "object",
  "description": "インスタンス構成",
  "properties": {
    "instance_limit": {
      "type": "number",
      "format": "double",
      "description": "インスタンス使用制限（秒"
    }
  }
}

インスタンス構成の更新

リクエストのコンテキストパラメータからCRNを使用して、指定されたインスタンスのコンフィギュレーションを更新する。

許可

quantum-computing.instance.configuration.update

監査

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

quantum-computing.instance.configuration.update

入力

本文パラメーター
名前、タイプ	説明
instance_limit integer	このフィールドはNULLか整数である。インスタンス制限をリセット/削除するにはnullを使用する。最小値:: `1` 最大値:: `2147483647`

コード・サンプル

PUT

/v1/instances/configuration

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

curl -X PUT \
  'https://quantum.cloud.ibm.com/api/v1/instances/configuration' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/configuration

import requests

response = requests.request(
    "PUT",
    "https://quantum.cloud.ibm.com/api/v1/instances/configuration",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2026-04-15",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

出力

HTTP応答状況コード
状況コード	説明
204	終了
400	誤った要求
401	認証されていません
403	禁止
404	未検出
409	使用量がインスタンス制限を超える

応答

状況コード

終了

インスタンス使用量の取得

許可

quantum-computing.instance-usage.read

監査

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

quantum-computing.instance-usage.read

入力

情報
このエンドポイントは入力を受け付けません。

コード・サンプル

GET

/v1/instances/usage

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/usage

curl -X GET \
  'https://quantum.cloud.ibm.com/api/v1/instances/usage' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR-TOKEN' \
  -H 'Service-CRN: YOUR-SERVICE-CRN' \
  -H 'IBM-API-Version: 2026-04-15'

インスタンスが eu-de リージョンにある場合は、代わりにこちらの URL をご利用ください: https://eu-de.quantum.cloud.ibm.com/api/v1/instances/usage

import requests

response = requests.request(
    "GET",
    "https://quantum.cloud.ibm.com/api/v1/instances/usage",
    headers={
      "Accept": "application/json",
      "IBM-API-Version": "2026-04-15",
      "Authorization": "Bearer YOUR-TOKEN",
      "Service-CRN": "YOUR-SERVICE-CRN"
    },
)
print(response.json())

出力

HTTP応答状況コード
状況コード	説明
200
401	認証されていません

応答

状況コード

{
  "instance_id": "example",
  "plan_id": "example",
  "usage_period": {
    "start_time": "example",
    "end_time": "example"
  },
  "usage_consumed_seconds": 12,
  "usage_limit_seconds": 60,
  "usage_allocation_seconds": 120,
  "usage_limit_reached": true,
  "time_available_at": "2024-01-01T00:00:00.000Z"
}

{
  "type": "object",
  "properties": {
    "instance_id": {
      "type": "string"
    },
    "plan_id": {
      "type": "string"
    },
    "usage_period": {
      "description": "利用期間の開始時刻と終了時刻",
      "allOf": [
        {
          "type": "object",
          "properties": {
            "start_time": {
              "format": "date-time",
              "type": "string",
              "description": "利用開始時間"
            },
            "end_time": {
              "format": "date-time",
              "type": "string",
              "description": "利用終了時間"
            }
          }
        }
      ]
    },
    "usage_consumed_seconds": {
      "type": "number",
      "example": 12,
      "description": "現在の利用期間に消費された使用量"
    },
    "usage_limit_seconds": {
      "type": "number",
      "example": 60,
      "description": "使用期間中の秒単位の使用制限"
    },
    "usage_allocation_seconds": {
      "type": "number",
      "example": 120,
      "description": "使用期間中にインスタンスに割り当てられる秒数"
    },
    "usage_limit_reached": {
      "type": "boolean",
      "example": false,
      "description": "使用制限に達した場合は真。 到達していなければfalse。 使用制限がこのインスタンスに適用されない場合は未定義。"
    },
    "time_available_at": {
      "format": "date-time",
      "type": "string",
      "description": "28日間の期間から古い利用履歴が除外されることにより、利用量がインスタンス制限を下回ることになる最も早い日時。 ローリングウィンドウ計画において、インスタンスレベルの上限に達した場合にのみ表示されます。",
      "example": "2024-01-01T00:00:00.000Z",
      "minLength": 20,
      "maxLength": 29
    }
  },
  "required": [
    "instance_id",
    "plan_id",
    "usage_consumed_seconds"
  ]
}