Queries information about the type, minor version, and bandwidth of specific nodes in an ApsaraDB for Redis instance, and zones where the nodes are 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.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

InstanceId String Yes r-t4nlenc2p04uvb****

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

QueryType Integer No 0

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
PageNumber Integer No 1

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.

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
RequestId String 224B97FB-A275-4EAC-86E9-8922FEA2****

The ID of the request.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

TotalCount Integer 2

The total number of entries returned.

Node Array of NodeInfo

Details about each node in an ApsaraDB for Redis instance.

NodeInfo
DefaultBandWidth Long 96

The default bandwidth of the node. Unit: MB/s.

CurrentMinorVersion String redis-5.0_0.3.10

The minor version of the node.

CurrentBandWidth Long 100

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.
InsType Integer 3

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.
IsLatestVersion Integer 1

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.
InsName String r-t4nlenc2p04uvb****

The ID of the node.

NodeType String normal

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.
ZoneId String cn-hangzhou-b

The ID of the zone.

IsOpenBandWidthService Boolean true

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.
CustinsId String 30381****

The ID of the data shard.

Role String master

The role of the node. Valid values:

  • master: master node
  • slave: replica node
NodeId String 10065****

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

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeRoleZoneInfoResponse>
    <TotalCount>2</TotalCount>
    <RequestId>224B97FB-A275-4EAC-86E9-8922FEA2****</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Node>
        <NodeInfo>
            <Role>slave</Role>
            <IsLatestVersion>1</IsLatestVersion>
            <ZoneId>cn-hangzhou-b</ZoneId>
            <NodeType>normal</NodeType>
            <IsOpenBandWidthService>true</IsOpenBandWidthService>
            <NodeId>10065****</NodeId>
            <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
            <CustinsId>30381****</CustinsId>
            <DefaultBandWidth>96</DefaultBandWidth>
            <InsName>r-t4nlenc2p04uvb****</InsName>
            <CurrentBandWidth>100</CurrentBandWidth>
        </NodeInfo>
        <NodeInfo>
            <Role>master</Role>
            <IsLatestVersion>1</IsLatestVersion>
            <ZoneId>cn-hangzhou-b</ZoneId>
            <NodeType>normal</NodeType>
            <IsOpenBandWidthService>true</IsOpenBandWidthService>
            <NodeId>10065****</NodeId>
            <CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
            <CustinsId>30381****</CustinsId>
            <DefaultBandWidth>96</DefaultBandWidth>
            <InsName>r-t4nlenc2p04uvb****</InsName>
            <CurrentBandWidth>100</CurrentBandWidth>
        </NodeInfo>
    </Node>
</DescribeRoleZoneInfoResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "RequestId" : "224B97FB-A275-4EAC-86E9-8922FEA2****",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Node" : {
    "NodeInfo" : [ {
      "Role" : "slave",
      "IsLatestVersion" : 1,
      "ZoneId" : "cn-hangzhou-b",
      "NodeType" : "normal",
      "IsOpenBandWidthService" : true,
      "NodeId" : "10065****",
      "CurrentMinorVersion" : "redis-5.0_0.3.10",
      "CustinsId" : "30381****",
      "DefaultBandWidth" : 96,
      "InsName" : "r-t4nlenc2p04uvb****",
      "CurrentBandWidth" : 100
    }, {
      "Role" : "master",
      "IsLatestVersion" : 1,
      "ZoneId" : "cn-hangzhou-b",
      "NodeType" : "normal",
      "IsOpenBandWidthService" : true,
      "NodeId" : "10065****",
      "CurrentMinorVersion" : "redis-5.0_0.3.10",
      "CustinsId" : "30381****",
      "DefaultBandWidth" : 96,
      "InsName" : "r-t4nlenc2p04uvb****",
      "CurrentBandWidth" : 100
    } ]
  }
}

Error codes

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