Overview
You can call this API to query the topology information of an instance.
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}/topology
Request parameters
Path
| Parameter | Type | Required | Description |
|---|---|---|---|
| instanceId | String | Yes | The ID of the instance in OceanBase Cloud. |
Query
| Parameter | Type | Required | Description |
|---|---|---|---|
| requestId | String | Yes | The ID of the request. Used for troubleshooting. |
Response parameters
| Parameter | Type | Description |
|---|---|---|
| data | Object | The topology data. |
| requestId | String | The ID of the request. |
| success | Boolean | Indicates whether the request was successful. |
Examples
Request example
curl --digest -u '<your ak:sk>' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/topology?requestId={requestId}'
Response example
JSON format
{
"data": {},
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"success": true
}