Queries information about the role, type, and minor version of specific nodes in an ApsaraDB for Redis instance, and zones where the instance is deployed.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeRoleZoneInfo

The operation that you want to perform. Set the value to DescribeRoleZoneInfo.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance. You can call the DescribeInstances operation to query instance IDs.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed. You can call the DescribeRegions operation to query region IDs.

QueryType Integer No 0

The type of the node to query. Valid values:

  • 0: the proxy node.
  • 1: the data node. This is the default value.
PageNumber Integer No 1

The number of the page to return. It 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.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 10, 20, and 50. Default value: 10.

Response parameters

Parameter Type Example Description
Node Array of NodeInfo

Details of each node on an ApsaraDB for Redis instance.

NodeInfo
CurrentMinorVersion String redis-5.0_0.3.10

The minor version of the node.

CustinsId String 38707894

This parameter is only used for internal maintenance of the ApsaraDB for Redis instance.

InsName String r-bp1bjmqwlelmkh****-db-0

The ID of the node.

InsType Integer 3

Indicates whether the instance is a read replica node. If it is a read replica node, 3 is returned for this parameter.

Note No value is returned for this parameter if the instance is not a read replica node.
IsLatestVersion Integer 1

Indicates whether the minor version is the latest one. Valid values:

  • 0: no.
  • 1: yes.
Note To upgrade the minor version, call the ModifyInstanceMinorVersion operation.
NodeId String 1595****

This parameter is only used for internal maintenance of the ApsaraDB for Redis instance.

NodeType String db

The type of node. Valid values:

  • proxy: the proxy node.
  • db: the data node.
Role String master

The role of the node. Valid values:

  • master: the master node.
  • slave: the replica node.
ZoneId String cn-hangzhou-b

The ID of the zone to which the instance belongs.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned on each page.

RequestId String 224B97FB-A275-4EAC-86E9-8922FEA2****

The ID of the request.

TotalCount Integer 4

The total number of entries that were returned.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeRoleZoneInfo
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<DescribeRoleZoneInfoResponse>
      <TotalCount>4</TotalCount>
      <RequestId>224B97FB-A275-4EAC-86E9-8922FEA2****</RequestId>
      <Node>
            <NodeInfo>
                  <Role>master</Role>
                  <IsLatestVersion>1</IsLatestVersion>
                  <ZoneId>cn-hangzhou-b</ZoneId>
                  <NodeType>db</NodeType>
                  <NodeId>1595****</NodeId>
                  <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
                  <CustinsId>3870****</CustinsId>
                  <InsName>r-bp1bjmqwlelmkh****-db-0</InsName>
            </NodeInfo>
            <NodeInfo>
                  <Role>slave</Role>
                  <IsLatestVersion>1</IsLatestVersion>
                  <ZoneId>cn-hangzhou-b</ZoneId>
                  <NodeType>db</NodeType>
                  <NodeId>1595****</NodeId>
                  <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
                  <CustinsId>3870****</CustinsId>
                  <InsName>r-bp1bjmqwlelmkh****-db-0</InsName>
            </NodeInfo>
            <NodeInfo>
                  <Role>master</Role>
                  <IsLatestVersion>1</IsLatestVersion>
                  <ZoneId>cn-hangzhou-b</ZoneId>
                  <NodeType>db</NodeType>
                  <NodeId>1595****</NodeId>
                  <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
                  <CustinsId>3870****</CustinsId>
                  <InsName>r-bp1bjmqwlelmkh****-db-1</InsName>
            </NodeInfo>
            <NodeInfo>
                  <Role>slave</Role>
                  <IsLatestVersion>1</IsLatestVersion>
                  <ZoneId>cn-hangzhou-b</ZoneId>
                  <NodeType>db</NodeType>
                  <NodeId>1595****</NodeId>
                  <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
                  <CustinsId>3870****</CustinsId>
                  <InsName>r-bp1bjmqwlelmkh****-db-1</InsName>
            </NodeInfo>
      </Node>
</DescribeRoleZoneInfoResponse>

JSON format

{
	"TotalCount": 4,
	"RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
	"Node": {
		"NodeInfo": [
			{
				"Role": "master",
				"IsLatestVersion": 1,
				"ZoneId": "cn-hangzhou-b",
				"NodeType": "db",
				"NodeId": "1595****",
				"CurrentMinorVersion": "redis-5.0_0.3.10",
				"CustinsId": "3870****",
				"InsName": "r-bp1bjmqwlelmkh****-db-0"
			},
			{
				"Role": "slave",
				"IsLatestVersion": 1,
				"ZoneId": "cn-hangzhou-b",
				"NodeType": "db",
				"NodeId": "1595****",
				"CurrentMinorVersion": "redis-5.0_0.3.10",
				"CustinsId": "3870****",
				"InsName": "r-bp1bjmqwlelmkh****-db-0"
			},
			{
				"Role": "master",
				"IsLatestVersion": 1,
				"ZoneId": "cn-hangzhou-b",
				"NodeType": "db",
				"NodeId": "1595****",
				"CurrentMinorVersion": "redis-5.0_0.3.10",
				"CustinsId": "3870****",
				"InsName": "r-bp1bjmqwlelmkh****-db-1"
			},
			{
				"Role": "slave",
				"IsLatestVersion": 1,
				"ZoneId": "cn-hangzhou-b",
				"NodeType": "db",
				"NodeId": "1595****",
				"CurrentMinorVersion": "redis-5.0_0.3.10",
				"CustinsId": "3870****",
				"InsName": "r-bp1bjmqwlelmkh****-db-1"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.