機能の概要
このAPIは、OceanBase Cloudインスタンスの詳細情報を取得するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}
リクエストパラメータ
Query
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Path
パラメータ |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBaseクラスタID | obcluster-***** |
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オブジェクトのフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| region | String | 一部のオブジェクトストレージベンダーでは入力が必要です。例：S3 | ap-guangzhou |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| instanceName | String | クラスタ名 | test-clu**** |
| instanceClass | String | クラスタ仕様 | xxxxxx |
| series | String | インスタンスシリーズ。 | NORMAL |
| payType | String | 支払いタイプ。 | POSTPAID |
| createTime | String | "2020-12-23T04:14:48Z" 作成日時 |
2026-02-25 15:40:43+00:00 |
| expireTime | String | "2020-12-23T04:14:48Z" 有効期限 |
2020-12-23 04:14:48+00:00 |
| availableZones | Array | ["h", "i", "j"] 利用可能ゾーン |
["h"] |
| version | String | "2.2.52" OBバージョン |
2.2.52 |
| obRpmVersion | String | "4.2.1.0-100020042023102310" OB RPMバージョン |
4.2.1.0-100020042023102310 |
| deployType | String | デプロイタイプ。有効な値：single（単一データセンターデプロイ）、multiple（複数データセンターデプロイ）、dual（デュアルデータセンターデプロイ）。 |
single |
| diskType | String | ストレージタイプ。cloud_essd_pl1はESSDクラウドディスクを表し、ephemeral_ssdはローカルSSDディスクを表します。 |
cloud_essd |
| deployMode | String | "1-1-1" デプロイモード |
1-1-1 |
| replicaMode | String | フル機能レプリカ数。有効な値：2と3。 |
2 |
| dataMergeTime | String | "02:00" データマージ時間 |
02:00 |
| status | 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 |
| cloudProvider | String | リソースまたはデータソースが存在するクラウドベンダー | xxxxxx |
| instanceType | String | インスタンスタイプ | DEDICATE**** |
| instanceRole | String | インスタンスロール。例：プライマリインスタンスまたはスタンバイインスタンス。 | xxxxxx |
| primaryInstanceId | String | 2022-05-10 プライマリインスタンスID、instanceRole=PHYSICAL_STANDBYの場合のみ有効 | obcluste**** |
| standbyInstanceIds | Array | 2022-05-10 スタンバイインスタンスID、instanceRole=PRIMARYの場合のみ有効 | ["obclus****"] |
| customTenantLogTransferMethod | String | データベースのカスタムクロスクラウドログ同期方式。instanceRoleがPHYSICAL_STANDBYの場合に有効です。 列挙：NETWORK、ARCHIVE_LOG | xxxxxx |
| saleChannel | String | 販売チャネル：overseas: グローバル自社チャネル domestic: 中国自社チャネル aliyun_domestic: Alibaba Cloud中国サイト huawei_mp_domestic: Huawei Cloud中国サイト aws_mp_domestic: AWS中国サイト aws-mp: AWSグローバルサイト aliyun_overseas: Alibaba Cloudグローバルサイト gcp_mp: GCP Marketplace | domestic |
| managementMode | String | 管理モード | DBAAS |
| tagList | Array | クラスタインスタンスのタグリスト | [{"tagKey": "env", "tagValue": "prod"}] |
| nodeNum | Integer | ノード数 | 3 |
| cpuArchitecture | String | CPUアーキテクチャ。 | 4 |
| projectId | String | プロジェクトID | hxq3ztx3377nby3v87ry**** |
| stopTime | String | 停止時間。 | 2026-02-26 10:40:43+00:00 |
| storageArchitecture | String | ストレージアーキテクチャ：shareStorage/standardStorage（共有ストレージ/標準ストレージ） | standardStorage |
| storageDiskType | String | ストレージタイプ。現在、ストレージタイプを選択できるのはTPモードのみで、OBPL1のみをサポートしています。 | OBPL1 |
| originalDeployMode | String | "1-1-1" 元のデプロイモード |
1-1-1 |
| inTempCapacityStatus | Boolean | 一時的な変更状態にあるかどうか | true |
data.availableZones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.availableZones[] | String | ["h", "i", "j"] 利用可能ゾーン |
"h" |
- "h" |
data.standbyInstanceIds[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.standbyInstanceIds[] | String | 2022-05-10 スタンバイインスタンスID。instanceRoleがPRIMARYの場合に有効です | "o****" |
- "o**** |
data.tagList[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tagKey | String | タグキー | env |
| tagValue | String | タグ値 | prod |
例
リクエスト例
curl --request GET \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"region": "ap-guangzhou",
"vpcId": "vpc-xxxx****",
"instanceId": "obcluster-*****",
"instanceName": "test-clu****",
"instanceClass": "xxxxxx",
"series": "NORMAL",
"payType": "POSTPAID",
"createTime": "2026-02-25 15:40:43+00:00",
"expireTime": "2020-12-23 04:14:48+00:00",
"availableZones": "---\n- \"h\"",
"version": "2.2.52",
"obRpmVersion": "4.2.1.0-100020042023102310",
"deployType": "single",
"diskType": "cloud_essd",
"deployMode": "1-1-1",
"replicaMode": "2",
"dataMergeTime": "02:00",
"status": "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
}
},
"cloudProvider": "xxxxxx",
"instanceType": "DEDICATE****",
"instanceRole": "xxxxxx",
"primaryInstanceId": "obcluste****",
"standbyInstanceIds": "---\n- \"o****",
"customTenantLogTransferMethod": "xxxxxx",
"saleChannel": "domestic",
"managementMode": "DBAAS",
"tagList": [
{
"tagKey": "env",
"tagValue": "prod"
}
],
"nodeNum": 3,
"cpuArchitecture": "4",
"projectId": "hxq3ztx3377nby3v87ry****",
"stopTime": "2026-02-26 10:40:43+00:00",
"storageArchitecture": "standardStorage",
"storageDiskType": "OBPL1",
"originalDeployMode": "1-1-1",
"inTempCapacityStatus": true
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}