Overview
You can call this API to query the node information of an OceanBase cluster.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/nodes/options
Request parameters
Query
| Name | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| data | object | The node information of the cluster. | |
| ip | string | The private IP address. | 10.10.xxx.xxx |
| nodeId | string | The ID of the node. | i-02********* |
Examples
Request example
curl --digest -u 'ak:sk' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/nodes/options
-H 'X-Ob-Project-Id: <Project ID>'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
JSON format
{
"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
}