Call DescribeRoleZoneInfo to query node role, type, version, and zone - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeRoleZoneInfo

get

*All Resource

*

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 the node to query. Default value: 1. Valid values: 0: proxy node Note** This parameter is supported only for cluster instances and read/write splitting instances. 1: data node	0
PageNumber	integer	No	The page number. Valid values: positive integers. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 10, 20, and 50. Default value: 10.	10

Response elements

Element	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	object
NodeInfo	array<object>	Details about each node in the instance.
	object
DefaultBandWidth	integer	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	integer	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	Whether the node is a read replica. A value of 3 indicates a read replica. Note If the node is not a read replica, no value is returned.	3
IsLatestVersion	integer	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	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	Used only for internal instance maintenance.	10065****

Examples

Success response

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.