Queries the role, type, minor version, and zone of each node in an ApsaraDB for Redis instance.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
kvstore:DescribeRoleZoneInfo | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the instance. You can call the DescribeInstances operation to query instance IDs. | r-t4nlenc2p04uvb**** |
QueryType | integer | No | The type of node to query. Default value: 1. Valid values:
Note
This parameter is supported only for cluster and read/write splitting instances.
| 0 |
PageNumber | integer | No | The number of the page to return. The value must be an integer that is greater than 0 and less than or equal to the maximum value supported by the integer data type. Default value: 1. | 1 |
PageSize | integer | No | The number of entries to return on each page. Valid values: 10, 20, and 50. Default value: 10. | 10 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 2,
"Node": {
"NodeInfo": [
{
"DefaultBandWidth": 96,
"CurrentMinorVersion": "redis-5.0_0.3.10",
"CurrentBandWidth": 100,
"InsType": 3,
"IsLatestVersion": 1,
"InsName": "r-t4nlenc2p04uvb****",
"NodeType": "normal",
"ZoneId": "cn-hangzhou-b",
"IsOpenBandWidthService": true,
"CustinsId": "30381****",
"Role": "master",
"NodeId": "10065****"
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-26 | The internal configuration of the API is changed, but the call is not affected | View Change Details |