機能の概要
指定されたOB Cloudインスタンスのトポロジー情報（ゾーンの分布、ノードリストなどの詳細情報）を取得します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/topology
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| instanceId | String | はい | OB CloudデータベースインスタンスID |
Query
パラメータ名 |
型 |
必須 |
説明 |
|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます |
戻り値
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | Object | トポロジーデータ |
| requestId | String | リクエストID |
| success | Boolean | リクエストが成功したかどうか |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/topology?requestId={requestId}'
戻り値の例
JSON形式
{
"data": {},
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"success": true
}