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

DescribeInstance - クラスタ情報を取得する

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

機能の概要

このAPIは、OceanBaseクラスタの詳細情報を照会するために使用されます。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウド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

名前	型	必須	説明	例値
なし

戻り結果

名前	型	説明	例値
data	object	クラスタの詳細データ情報。
diskType	string	クラスタがデプロイされているストレージタイプ。	cloud_essd
managementMode	string	クラスタの管理モード。 DBaaS: 通常モード。	DBaaS
series	string	OceanBaseクラスタシリーズ。デフォルトはNORMAL、標準クラスタ版（クラウドディスク）。normal_kvも含まれます、標準版クラスタ（key-value）	NORMAL
projectId	string	プロジェクトID。	li15c8s987d2arse********
availableZones	array	利用可能ゾーン	["4"]
version	string	OBServerバージョン情報。	3.2.3.0
obRpmVersion	String	OBServerの詳細バージョン情報	4.2.3.0-100000232024042317
cloudProvider	string	クラウドプロバイダー名。 > ALIYUN：Alibaba Cloud。 QCLOUD: Tencent Cloud。 AWS: Amazon Web Services。 AWSCN: Amazon Web Services China。 HUAWEI: Huawei Cloud。 GCP：Google Cloud Platform。	QCLOUD
createTime	string	クラスタの作成時間、UTC時刻。	2023-08-28T08:30:54Z
dataMergeTime	String	クラスタのデータマージ時間	18:00Z
deployMode	string	クラスタのデータレプリカモード。単一データセンターの場合はn。デュアルデータセンターの場合はn-n。マルチデータセンターの場合はn-n-n、ここでnは各データセンターのOBServerノード数です。	1-1-1
deployType	string	クラスタのデプロイメントタイプ。 multiple：マルチデータセンター。 single：シングルデータセンター。 dual：デュアルデータセンター。	multiple
instanceClass	string	クラスタ仕様情報。現在サポートされているプランは以下のとおりです： 4C16GiB 8C16GiB 8C32GiB 16C32GiB 16C70GiB 32C70GiB 32C180GiB 64C180GiB 64C400GiB	8C32G
instanceId	string	OB CloudクラウドデータベースインスタンスID。	ob5******
instanceName	string	OceanBaseクラスタ名。	test
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	販売チャネル： 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
NodeNum	String	クラスタノード数情報。デプロイメントモードがn-n-nの場合、ノード数はn × 3となります。	3
CpuArchitecture	String	クラスタのCPUアーキテクチャ。	X86
replicaMode	String	フル機能レプリカ数、戻り値は3と2のみ含まれます。 3：3つのフル機能レプリカを表します。 2：2つのフル機能レプリカを表します。 3ゾーン利用時は3つのフル機能レプリカのみサポート、デュアルゾーン利用時は2つのフル機能レプリカのみサポート、シングルゾーン利用時は2つまたは3つのフル機能レプリカをサポートします。	3
vpcId	String	専用ネットワークIP。	vpc-xxxxx
status	String	クラスタ状態： PENDING_CREATE: 作成中。 ONLINE: 実行中。 TENANT_CREATING：テナント作成中。 TENANT_SPEC_MODIFYING：テナント仕様変更中。 EXPANDING: ノード拡張中。 REDUCING: ノード縮小中。 SPEC_UPGRADING:プラン仕様拡張中。 DISK_UPGRADING:ストレージ仕様拡張中。 WHITE_LIST_MODIFYING: ホワイトリスト変更中。 PARAMETER_MODIFYING: パラメータ変更中。 SSL_MODIFYING: SSL変更中。 PREPAID_EXPIRE.Closed: 前払いクラスタの未払い中。 ARREARS.Closed: 従量課金クラスタの未払い中。 PENDING_DELETE: 削除中。クラスタは通常実行中の状態（ONLINE）にあります。	ONLINE
primaryInstanceId	String	プライマリクラスタID。
standbyInstanceIds	arr	スタンバイクラスタids。	["xxx","xxxx"]
tagList	arr	クラスタインスタンスのタグリスト。	[{"tagKey","tagValue"}]
expireTime	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>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>'

説明

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

レスポンス例

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

{
    "data":{
        "availableZones":[
            "d",
            "e"
        ],
        "cloudProvider":"HUAWEI",
        "cpuArchitecture":"X86",
        "createTime":"2024-11-11T02:39:33Z",
        "dataMergeTime":"18:00Z",
        "deployMode":"1-1-1",
        "deployType":"dual",
        "diskType":"cloud_essd",
        "instanceClass":"4C16G",
        "instanceId":"ob68cg********",
        "instanceName":"ob68cg********",
        "instanceRole":"NORMAL",
        "instanceType":"CLUSTER",
        "managementMode":"DBaaS",
        "nodeNum":3,
        "obRpmVersion":"4.1.0.2-104030012023121217",
        "payType":"POSTPAY",
        "projectId":"li15c8s987d2arse********",
        "region":"cn-southwest-2",
        "replicaMode":"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":[],
        "status":"ONLINE",
        "version":"4.1.0",
        "vpcId":"751bc080-d862-4917-972e-48ae********"
    },
    "requestId":"d5ce1e06-f263-4407-8ba0-5ad2********",
    "success":true
}

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

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

OceanBase

顧客事例