Overview
You can call this API to query the indexes of a specific database and table in an instance and tenant of OceanBase Cloud.
API details
Constraints
The caller must have an AccessKey for accessing APIs. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/indexes
Request parameters
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase Cloud instance. | obcluster-***** |
| tenantId | string | Yes | The ID of the tenant. | t4louaeei**** |
| requestId | string | Yes | The ID of the request, which is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
| dbName | string | Yes | The name of the database. | test_db |
| tableName | string | Yes | The name of the table. | test_table |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | string | The ID of the request. |
| server | string | The server address. |
| data | object | The returned data. |
Examples
Request example
curl -X GET \
-H "Content-Type: application/json" \
-u '<your ak:sk>' \
"https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/indexes?requestId={requestId}&dbName={dbName}&tableName={tableName}"
Response example
{
"requestId": "xxxxxx",
"server": "xxx.xxx.x.xxx:xxxx",
"data": {}
}