機能の概要
指定されたOB Cloudデータベースインスタンスとテナント内の特定のデータベースおよびテーブルのインデックス情報を照会します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/indexes
リクエストパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
| requestId | string | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
| dbName | string | はい | データベース名。 | test_db |
| tableName | string | はい | テーブル名。 | test_table |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| requestId | string | リクエストID。 |
| server | string | サーバーアドレス。 |
| data | object | 戻されるデータオブジェクト。 |
例
リクエスト例
curl -X GET \
-H "Content-Type: application/json" \
-u '<あなたのAK:SK>' \
"https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/indexes?requestId={requestId}&dbName={dbName}&tableName={tableName}"
戻り値の例
{
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"data": {}
}