Queries the information about nodes in an AnalyticDB for PostgreSQL instance.
Operation description
You can call this operation to query the distribution and states of coordinator and compute nodes in an AnalyticDB for PostgreSQL instance.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. Note
You can call the DescribeDBInstances operation to query details about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.
| gp-bp12ga6v69h86**** |
PageSize | integer | No | The number of entries per page. Valid values:
Default value: 20. | 20 |
PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
StartStatus | string | No | The running state of the node. Valid values:
If you do not specify this parameter, the information about nodes in all running states is returned. | UP |
SyncMode | string | No | The data synchronization state of the node. Valid values:
If you do not specify this parameter, the information about nodes in all synchronization states is returned. | synced |
RolePreferd | string | No | The role state of the node. It specifies whether a primary/secondary switchover occurs. Valid values:
| normal |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "070534EC-78D5-5519-83CC-E7B1A9213483",
"TotalCount": "6",
"PageNumber": "1",
"Items": [
{
"Hostname": "gp-t4np568qe9710****-master-100984919",
"NodeAddress": "192.168.XX.XX",
"NodeType": "master",
"NodeName": "ap-southeast-1.i-t4n4c4ryr0yr441d****",
"NodePort": "3000",
"NodeID": "1",
"NodeStatus": "UP",
"NodeRole": "primary",
"NodePreferredRole": "primary",
"NodeReplicationMode": "Synced",
"NodeCID": "-1"
}
],
"MasterStatusInfo": {
"NormalNodeNum": 2,
"ExceptionNodeNum": 0,
"NotSyncingNodeNum": 0,
"SyncedNodeNum": 1,
"PreferredNodeNum": 2,
"NotPreferredNodeNum": 0
},
"SegmentStatusInfo": {
"NormalNodeNum": 4,
"ExceptionNodeNum": 0,
"NotSyncingNodeNum": 4,
"SyncedNodeNum": 0,
"PreferredNodeNum": 4,
"NotPreferredNodeNum": 0
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|