機能の概要
このAPIは、OceanBase Cloudインスタンスの一覧情報を取得するために使用されます。クラスタ名、クラスタID、タグなどの条件でフィルタリングでき、ページネーションにも対応しています。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances
リクエストパラメータ
Query
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| X-Ob-Project-Id | String | はい | プロジェクトID。 | hxq3ztx3377nby3v87ry**** |
| instanceName | String | いいえ | クラスタ名。 | test-cluster |
| tenantSearchKey | String | いいえ | テナント検索キーワード。 | |
| instanceId | String | いいえ | クラスタID。 | obcluster-***** |
| tagList | String | いいえ | クラスタタグリスト。 | |
| organizationId | String | いいえ | 組織ID。 | |
| pageNumber | int | いいえ | ページ番号。 | 1 |
| pageSize | int | いいえ | ページサイズ。 | 10 |
Body
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| なし |
戻り値
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | None |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIPアドレス | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
dataオブジェクトのフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| dataList | Array | データセット | [{'id': 'resource-123456'}] |
| total | Number | データ総量 | 100.0 |
| hasMore | Boolean | まだデータがあるかどうか | true |
data.dataList[]要素のフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| region | String | 地域。 | ap-guangzhou |
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| instanceName | String | クラスタ名 | test-clu**** |
| instanceClass | String | クラスタ仕様 | xxxxxx |
| series | String | インスタンスシリーズ。 | NORMAL |
| gmtCreate | String | 作成時間 | 2026-02-25 15:40:43+00:00 |
| obRpmVersion | String | "4.2.1.0-100020042023102310" OB RPMバージョン |
4.2.1.0-100020042023102310 |
| version | String | "2.2.52" OBバージョン |
2.2.52 |
| maxCpu | Integer | 最大CPUスペック | 4 |
| maxMem | Integer | 最大メモリスペック(GB) | 16 |
| usedDiskSize | Integer | 使用済みディスク容量。 | 200 |
| state | String | ステータス（旧仕様のフィールド）。 | ONLINE |
| resource | Object | CPU、メモリ、ディスク、ノードリソースなどを含むリソース仕様情報 | None |
| resource.cpu | Object | プロセッサコア数または仕様情報。 | None |
| resource.cpu.totalCpu | Number | CPUの総コア数。 | 4.0 |
| resource.cpu.usedCpu | Number | 使用中のCPUコア数。 | 4.0 |
| resource.cpu.originalTotalCpu | Number | 変更前のCPU総コア数。 | 4.0 |
| resource.cpu.unitCpu | Number | Unitプロセッサ仕様。 | 2.0 |
| resource.memory | Object | リソース仕様のメモリ情報 | None |
| resource.memory.totalMemory | Number | メモリ総量。 | 16.0 |
| resource.memory.usedMemory | Number | 使用済みメモリ。 | 16.0 |
| resource.memory.originalTotalMemory | Number | 変更前のメモリ総量。 | 16.0 |
| resource.memory.unitMemory | Number | Unitのメモリサイズ(GB) | 8.0 |
| resource.memory.hostActualMemory | Number | ホストの実際のメモリサイズ、単位GiB | 16.0 |
| resource.memory.systemMemory | Number | フラッグシップ版ホストのシステムが使用するメモリ、単位GiB。= hostActualMemory - totalMemory | 16.0 |
| resource.memory.originalHostActualMemory | Number | 元の仕様に対応するホストの実際のメモリサイズ、単位GiB | 16.0 |
| resource.diskSize | Object | ディスクサイズ | None |
| resource.diskSize.totalDiskSize | Number | ディスク総容量。 | 200.0 |
| resource.diskSize.usedDiskSize | Number | 使用済みディスク容量。 | 200.0 |
| resource.diskSize.originalTotalDiskSize | Number | 変更前のディスク総容量。 | 200.0 |
| resource.diskSize.totalDataSize | Number | データ総量。 | 200.0 |
| resource.diskSize.unitDiskSize | Number | Unitのディスクサイズ | 200.0 |
| resource.diskSize.availableDiskSize | Number | ユーザーが実際に利用できるストレージサイズ(単位：GB) 計算式：getAvailableDiskSize(unitDiskSize, nodeCount, obVersion, shareStorageCluster) | 200.0 |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| deployMode | String | データレプリカモード(n/n-n/n-n-n) | 1-1-1 |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| payType | String | 支払いタイプ。 | POSTPAID |
| availableZones | Array | ["h", "i", "j"] 利用可能なゾーン |
['h'] |
| deployType | String | デプロイタイプ。有効値：single（単一データセンターデプロイ）、multiple（マルチデータセンターデプロイ）、dual（デュアルデータセンターデプロイ）。 |
single |
| gmtEnd | String | 終了時間 | 2026-02-25 15:40:43+00:00 |
| cloudProvider | String | リソースまたはデータソースが配置されているクラウドプロバイダー | xxxxxx |
| managementMode | String | 管理モード | DBAAS |
| instanceType | String | インスタンスタイプ | DEDICATE**** |
| diskType | String | ストレージタイプ。有効値：cloud_essd_pl1（ESSDクラウドディスク）および ephemeral_ssd（ローカルSSDディスク）。 |
cloud_essd |
| diskSize | Integer | ディスクサイズ | 200 |
| instanceRole | String | インスタンスロール。例：プライマリインスタンスまたはスタンバイインスタンス。 | xxxxxx |
| primaryInstanceId | String | 2022-05-10 プライマリインスタンスID。instanceRoleがPHYSICAL_STANDBYの場合にのみ有効です。 | obcluste**** |
| standbyInstanceIds | Array | 2022-05-10 スタンバイインスタンスID。instanceRoleがPRIMARYの場合にのみ有効です。 | ['obclus**** |
| stopTime | String | 停止時間。 | 2026-02-26 10:40:43+00:00 |
| saleChannel | String | 販売チャネル: overseas: グローバル直営チャネル domestic: 中国直営チャネル aliyun_domestic: Alibaba Cloud中国サイト huawei_mp_domestic: Huawei中国サイト aws_mp_domestic: AWS中国サイト aws-mp: AWSグローバルサイト aliyun_overseas: Alibaba Cloudグローバルサイト gcp_mp: GCP Marketplace | domestic |
| tagList | Array | タグリスト | [{'tagKey': 'env', 'tagValue': 'prod'}] |
| cpuArchitecture | String | CPUアーキテクチャ。 | 4 |
| storageArchitecture | String | ストレージアーキテクチャ、shareStorage/standardStorage 共有ストレージ/標準ストレージ | standardStorage |
| storageDiskType | String | ストレージタイプ。現在tpモードでのみストレージタイプの選択が可能で、OBPL1のみ対応しています | OBPL1 |
| inTempCapacityStatus | Boolean | 一時的なリソース構成変更状態にあるかどうか | true |
data.dataList[].availableZones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.dataList[].availableZones[] | String | ["h", "i", "j"] 利用可能なゾーン |
h |
- "h" |
data.dataList[].standbyInstanceIds[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.dataList[].standbyInstanceIds[] | String | 2022-05-10 スタンバイインスタンスID。instanceRoleがPRIMARYの場合にのみ有効です。 | o**** |
- "o**** |
data.dataList[].tagList[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tagKey | String | タグキー | env |
| tagValue | String | タグ値 | prod |
例
リクエスト例
curl --request GET \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
-H 'X-Ob-Project-Id: {projectId}' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances?requestId={requestId}&instanceName={instanceName}&instanceId={instanceId}&tenantSearchKey={tenantSearchKey}&organizationId={organizationId}&pageNumber={pageNumber}&pageSize={pageSize}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"dataList": [
{
"region": "ap-guangzhou",
"instanceId": "obcluster-*****",
"instanceName": "test-clu****",
"instanceClass": "xxxxxx",
"series": "NORMAL",
"gmtCreate": "2026-02-25 15:40:43+00:00",
"obRpmVersion": "4.2.1.0-100020042023102310",
"version": "2.2.52",
"maxCpu": 4,
"maxMem": 16,
"usedDiskSize": 200,
"state": "ONLINE",
"resource": {
"cpu": {
"totalCpu": 4.0,
"usedCpu": 4.0,
"originalTotalCpu": 4.0,
"unitCpu": 2.0
},
"memory": {
"totalMemory": 16.0,
"usedMemory": 16.0,
"originalTotalMemory": 16.0,
"unitMemory": 8.0,
"hostActualMemory": 16.0,
"systemMemory": 16.0,
"originalHostActualMemory": 16.0
},
"diskSize": {
"totalDiskSize": 200.0,
"usedDiskSize": 200.0,
"originalTotalDiskSize": 200.0,
"totalDataSize": 200.0,
"unitDiskSize": 200.0,
"availableDiskSize": 200.0
}
},
"status": "ONLINE",
"deployMode": "1-1-1",
"vpcId": "vpc-xxxx****",
"payType": "POSTPAID",
"availableZones": "---\n- \"h\"",
"deployType": "single",
"gmtEnd": "2026-02-25 15:40:43+00:00",
"cloudProvider": "xxxxxx",
"managementMode": "DBAAS",
"instanceType": "DEDICATE****",
"diskType": "cloud_essd",
"diskSize": 200,
"instanceRole": "xxxxxx",
"primaryInstanceId": "obcluste****",
"standbyInstanceIds": "---\n- \"o****",
"stopTime": "2026-02-26 10:40:43+00:00",
"saleChannel": "domestic",
"tagList": [
{
"tagKey": "env",
"tagValue": "prod"
}
],
"cpuArchitecture": "4",
"storageArchitecture": "standardStorage",
"storageDiskType": "OBPL1",
"inTempCapacityStatus": true
}
],
"total": 100.0,
"hasMore": true
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}