DescribeInstances - クラスタリストを取得する|OceanBase Cloud|ドキュメント|分散データベース

DescribeInstances - クラスタリストを取得する

最終更新日：2026-07-31 06:58:55 更新

機能の概要

このAPIは、OceanBaseクラスタの一覧情報を照会するために使用されます。クラスタ名、クラスタ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

名前	型	必須	説明	例値
なし

戻り値

名前	型	説明	例値
data	object	クラスタ情報。dataListプロパティフィールドを含みます。
dataList	arr	クラスタ情報リスト。プロパティは下記をご参照ください。
expireTime	String	有効期限。
managementMode	string	クラスタの管理モード。 DBaaS: 通常モード。	DBaaS
availableZones	array	ゾーン	["4"]
version	string	OBServerバージョン情報。	4.2.3
obRpmVersion	String	OBServer詳細バージョン情報	4.2.3.0-100000232024042317
cloudProvider	string	クラウドベンダー名。 Alibaba Cloud: ALIYUN AWS: AWS Tencent Cloud: QCLOUD Huawei Cloud: HUAWEI GCP: GCP	QCLOUD
createTime	string	クラスタの作成時間、UTC時刻。	2023-08-28T08:30:54Z
deployMode	string	クラスタのデータレプリカモード。ここで、nは各データセンターのOBServerノード数です。単一データセンターの場合はnです。デュアルデータセンターの場合はn-nです。マルチデータセンターの場合はn-n-nです。	1-1-1
deployType	string	クラスタのデプロイメントタイプ。 multiple: マルチデータセンター。 single: シングルデータセンター。 dual: デュアルデータセンター。	multiple
instanceClass	string	クラスタ仕様情報。現在、以下のプランをサポートしています： 4C16GiB 8C16GiB 8C32GiB 16C32GiB 16C70GiB 32C70GiB 32C180GiB 64C180GiB 64C400GiB	4C16G
instanceId	string	OB CloudクラウドデータベースインスタンスID。	ob5******
instanceName	string	OceanBaseクラスタ名。	ob********
instanceRole	string	OceanBaseインスタンスロール。	NORMAL
instanceType	string	クラスタタイプ。 DEDICATED: 専用クラスタモード SHARED: 共有クラスタモード CLUSTER: クラスタインスタンス PRIMARY_STANDBY_CLUSTER: スタンバイクラスタインスタンス K8s_DEDICATED: K8s専用クラスタモード ANALYTICAL_CLUSTER: APインスタンス K8s_SHARED: K8s共有クラスタモード KV_CLUSTER: KVインスタンス SHARED_STORAGE_CLUSTER: 共有ストレージクラスタ	CLUSTER
payType	string	OceanBaseクラスタの支払いタイプ： PREPAY：前払い。 POSTPAY：従量課金。	POSTPAY
region	string	リージョン。	ap-guangzhou
saleChannel	String	販売チャネル。デフォルトは自社運営チャネル：説明現在、一時的にnormandyチャネルでの注文のみをサポートしています。 overseas: 海外自社運営チャネル domestic: 国内自社運営チャネル normandy_domestic: 诺曼底チャネル aliyun_domestic: Alibaba Cloud中国站 huawei_mp_domestic: 华为云中国站 aws_mp_domestic: AWS中国站 aws-mp: AWS Marketplace aliyun_overseas: Alibaba Cloud海外站 gcp_mp: GCP Marketplace	domestic
vpcId	String	プライベートネットワークID。	vpc-xxxxx
status	string	クラスタの状態： PENDING_CREATE: 作成中。 ONLINE: 実行中。 TENANT_CREATING：テナント作成中。 </ li> TENANT_SPEC_MODIFYING：テナント仕様変更中。 </ li> EXPANDING: ノード拡張中。 </ li> REDUCING: ノード縮小中。 </ li> SPEC_UPGRADING：プラン仕様拡張中。 </ li> DISK_UPGRADING：ストレージ仕様拡張中。 </ li> WHITE_LIST_MODIFYING: ホワイトリスト変更中。 PARAMETER_MODIFYING: パラメータ変更中。 </ li> SSL_MODIFYING: SSL変更中。 </ li> PREPAID_EXPIRE.Closed: 前払いクラスタの料金未払い中。 </ li> ARREARS.Closed: 従量課金クラスタの料金未払い中。 </ li> PENDING_DELETE: 削除中。クラスタは通常、実行中の状態（ONLINE）です。	ONLINE
series	string	OceanBaseクラスタシリーズ。デフォルトはNORMAL、標準クラスタ版（クラウドディスク）。normal_kvも含まれます、標準版クラスタ（キー・バリュー）	NORMAL
primaryInstanceId	String	プライマリクラスタID。
standbyInstanceIds	arr	スタンバイクラスタids。	["xxx","xxxx"]
cpuArchitecture	String	CPUアーキテクチャ商品値：X86/ARM	X86
cpu	integer	クラスタのCPUコア数。	8
mem	long	クラスタのメモリサイズ、単位GiB。	32
diskSize	long	ストレージ容量、単位GiB。	100
diskType	string	クラスタデプロイのストレージタイプ。	cloud_essd
state	string	インスタンスの状態。	ONLINE
usedDiskSize	long	クラスタの使用済みストレージ容量、単位GiB。	1
stopTime	String	停止時間。
resource	object	クラスタのリソース情報。
cpu	object	クラスタのCPUリソース情報。
totalCpu	long	クラスタ総CPU、単位：コア数。	4.0
usedCpu	long	クラスタの使用済みCPU、単位：コア数。	1.0
disk	object	クラスタのストレージリソース情報。
totalDiskSize	long	総ディスクサイズ。	100.0
usedDiskSize	long	使用ディスクサイズ。	1.0
memory	object	クラスタのメモリリソース情報。
totalMemory	long	総メモリサイズ。	16.0
usedMemory	long	使用メモリサイズ。	4.0
tagList	arr	クラスタインスタンスのタグリスト。
tagKey	String	タグkey。
tagValue	String	タグ値。
success	boolean	リクエストが成功したかどうか。	true/false
requestId	String	trace	dc302d76-66b5-48d8-ab53-a035********（64ビット）

例

リクエスト例

curl --request GET \
--digest -u '<Your AK:SK>' \
-H 'X-Ob-Project-Id: {projectId}' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances?requestId={requestId}&instanceName={instanceName}&pageNumber={pageNumber}&pageSize={pageSize}'

説明

プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。

レスポンス例

リクエスト成功時のレスポンス例：

{
    "data":{
        "dataList":[
            {
                "availableZones":[
                    "4"
                ],
                "cloudProvider":"QCLOUD",
                "cpu":4,
                "cpuArchitecture":"X86",
                "createTime":"2024-11-12T08:12:35Z",
                "deployMode":"1-1-1",
                "deployType":"single",
                "diskSize":0,
                "diskType":"cloud_essd",
                "instanceClass":"4C16G",
                "instanceId":"ob68gu********",
                "instanceName":"ob68gu********",
                "instanceRole":"NORMAL",
                "instanceType":"cluster",
                "managementMode":"DBaaS",
                "mem":16,
                "obRpmVersion":"4.2.0.0-100000052023073123",
                "payType":"POSTPAY",
                "region":"ap-beijing",
                "resource":{
                    "cpu":{
                        "totalCpu":4.0,
                        "usedCpu":0.0
                    },
                    "disk":{
                        "totalDiskSize":100.0,
                        "usedDiskSize":1.0
                    },
                    "memory":{
                        "totalMemory":16.0,
                        "usedMemory":0.0
                    }
                },
                "saleChannel":"domestic",
                "series":"NORMAL",
                "standbyInstanceIds":[],
                "state":"STOPPED",
                "status":"STOPPED",
                "stopTime":"2024-11-12T08:39:43Z",
                "tagList":[],
                "usedDiskSize":1,
                "version":"4.2.0",
                "vpcId":"vpc-********"
            },
            {
                "availableZones":[
                    "d",
                    "e"
                ],
                "cloudProvider":"HUAWEI",
                "cpu":4,
                "cpuArchitecture":"X86",
                "createTime":"2024-11-11T02:39:33Z",
                "deployMode":"1-1-1",
                "deployType":"dual",
                "diskSize":0,
                "diskType":"cloud_essd",
                "instanceClass":"4C16G",
                "instanceId":"ob68cg********",
                "instanceName":"ob68cg********",
                "instanceRole":"NORMAL",
                "instanceType":"cluster",
                "managementMode":"DBaaS",
                "mem":16,
                "obRpmVersion":"4.1.0.2-104030012023121217",
                "payType":"POSTPAY",
                "region":"cn-southwest-2",
                "resource":{
                    "cpu":{
                        "totalCpu":4.0,
                        "usedCpu":2.0
                    },
                    "disk":{
                        "totalDiskSize":100.0,
                        "usedDiskSize":1.0
                    },
                    "memory":{
                        "totalMemory":16.0,
                        "usedMemory":8.0
                    }
                },
                "saleChannel":"domestic",
                "series":"NORMAL",
                "standbyInstanceIds":[],
                "state":"ONLINE",
                "status":"ONLINE",
                "tagList":[],
                "usedDiskSize":1,
                "version":"4.1.0",
                "vpcId":"751bc080-d862-4917-972e-48ae********"
            }
        ],
        "total":2
    },
    "requestId":"b819053c-8969-4373-bc6e-f3a3********",
    "success":true
}

リクエスト失敗時のレスポンス例：

{
    "errorCode": "Params.InstanceName.Invalid",
    "errorMessage": "Cluster name validation failed",
    "requestId": "cb32942e-bdf2-4d85-a26f-6bf8********",
    "success": false
}

OceanBase

顧客事例