Querying CNs
Function
This API is used to query CNs. Before calling this API:
- Learn how to authenticate this API.
URI
GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/coordinators
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None |
| instance_id | Yes | String | Instance ID, which is compliant with the UUID format. |
Request Parameters
None
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| instance_id | String | Instance ID. |
| max_reduction_num | Integer | Maximum number of nodes that can be deleted at a time. |
| nodes | Array of Table 3 objects | Node information list. |
| Parameter | Type | Description |
|---|---|---|
| id | String | Node ID. |
| name | String | Node name. |
| status | String | Node status.
|
| availability_zone | String | AZ. |
| support_reduce | Boolean | Whether the node can be deleted. |
Example Request
Querying CNs
GET https://gaussdb-opengauss.eu-west-101.myhuaweicloud.eu/v3/0c8243400d37468bb4aed3cc94c2911d/instances/f9b5f9b296ec6808e067in14/coordinators
Example Response
CNs queried.
{
"instance_id" : "cc6fd964d93f4003851dfc29d57d30a5in14",
"max_reduction_num" : 10,
"nodes" : [ {
"id" : "25b7f16ee4084b7884d52f1bdfab4e68no14",
"name" : "UTS-gauss-7362_gaussdbv5cn_0",
"status" : "normal",
"availability_zone" : "az2",
"support_reduce" : true
}, {
"id" : "ad6f02f31744422fa8ce487e81c9e7afno14",
"name" : "UTS-gauss-7362_gaussdbv5cn_1",
"status" : "normal",
"availability_zone" : "az3",
"support_reduce" : true
} ]
} Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
