機能説明
このインターフェースは、指定されたOceanBaseクラスタでモニタリングクエリに使用可能なノードのリストオプションを照会するために使用されます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/nodes/options
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
戻り結果
名前 |
型 |
説明 |
例値 |
|---|---|---|---|
| data | array | ノードオプションのリスト。 | |
| ip | string | プライベートIPアドレス。 | 10.10.xxx.xxx |
| nodeId | string | ノードID情報。 | i-02********* |
例
リクエスト例
curl --digest -u '<あなたのak:sk>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/nodes/options?requestId={requestId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"data":[
{
"ip":"10.10.xxx.xxx",
"nodeId":"i-02*********"
},
{
"ip":"10.10.xxx.xxx",
"nodeId":"i-*********"
},
{
"ip":"10.10.xxx.xxx",
"nodeId":"i-*********"
}
],
"requestId":"5ea93350-********-8434",
"success":true
}