DescribeRoleZoneInfo - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Queries the role, type, minor version, and zone of each node in a Tair (Redis OSS-compatible) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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	All Resources ``	none	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: 0: proxy node Note This parameter is supported only for cluster and read/write splitting instances. 1: data node	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	224B97FB-A275-4EAC-86E9-8922FEA2****
PageNumber	integer	The number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of entries returned.	2
Node	array<object>	Details about each node in an ApsaraDB for Redis instance.
NodeInfo	object
DefaultBandWidth	long	The default bandwidth of the node. Unit: MB/s.	96
CurrentMinorVersion	string	The minor version of the node.	redis-5.0_0.3.10
CurrentBandWidth	long	The current bandwidth of the node, which consists of the default bandwidth and the increased bandwidth. Unit: MB/s. Note You can call the EnableAdditionalBandwidth operation to specify the increased bandwidth. You can also use this parameter to calculate the increased bandwidth. For example, if the default bandwidth of the node is 96 MB/s and the returned value of this parameter is 100, the increased bandwidth is 4 MB/s.	100
InsType	integer	Indicates whether the node is a read replica. If the node is a read replica, 3 is returned. Note If the node is not a read replica, no value is returned.	3
IsLatestVersion	integer	Indicates whether the minor version is the latest version. Valid values: 0: The minor version is not the latest version. 1: The minor version is the latest version. Note To update the minor version, call the ModifyInstanceMinorVersion operation.	1
InsName	string	The ID of the node.	r-t4nlenc2p04uvb****
NodeType	string	The node type. Valid values: db: data node. proxy: proxy node. normal: regular node. This value is returned when the instance runs in the standard architecture.	normal
ZoneId	string	The ID of the zone.	cn-hangzhou-b
IsOpenBandWidthService	boolean	Indicates whether the bandwidth of the node is increased. Valid values: true: The bandwidth of the node is not increased. false: The bandwidth of the node is increased.	true
CustinsId	string	The ID of the data shard.	30381****
Role	string	The role of the node. Valid values: master: master node slave: replica node	master
NodeId	string	This parameter is used only for internal maintenance of ApsaraDB for Redis instances.	10065****

Examples

Sample success responses

JSONformat

{
  "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