You can call DescribeLogicInstanceTopology to query the logical topology of an ApsaraDB for Redis instance.

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 No DescribeLogicInstanceTopology

The operation that you want to perform. Set this parameter to DescribeLogicInstanceTopology.

InstanceId String Yes r-bp1xxxxxxxxxxxxx

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String 5F749626-2B6A-4DC2-A010-B51F7C33084E

The ID of the request.

InstanceId String r-bp1xxxxxxxxxxxxx

The ID of the instance.

RedisProxyList Array

The detailed proxy information, including information of proxy nodes.

NodeId String r-xxxxxxxxxxxxxxx-proxy-3#5425423

The ID of the node.

Connection String 320000

The maximum number of connections.

Bandwidth String 96

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

Capacity String 5120

The storage capacity of the node. Unit: MB.

NodeType String proxy

The type of the node. Valid values:

  • proxy: proxy node.
  • db: data node.
RedisShardList Array

The detailed shard/node information.

NodeId String r-bp1xxxxxxxxxxxxx-db-0#6889415

The ID of the node.

Connection String 10000

The maximum number of connections.

Bandwidth String 96

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

Capacity String 2,048

The storage capacity of the node. Unit: MB.

NodeType String db

The type of the node. Valid values:

  • proxy: proxy node.
  • db: data node.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/
?Action=DescribeLogicInstanceTopology
&InstanceId=r-bp1xxxxxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format

<DescribeLogicInstanceTopologyResponse>
      <RedisShardList>
        <NodeInfo>
              <NodeId>r-xxxxxxxxxxxxxxx-proxy-3#5425423</NodeId>
              <NodeType>proxy</NodeType>
              <Capacity>5120</Capacity>
              <Connection>320000</Connection>
              <Bandwidth>96</Bandwidth>
        </NodeInfo>
      </RedisShardList>
      <InstanceId>pd-xxxxxxxxxxxxxx</InstanceId>
      <RequestId>5F749626-2B6A-4DC2-A010-B51F7C33084E</RequestId>
</DescribeLogicInstanceTopologyResponse>

JSON format

{
  "RedisShardList":
    {"NodeInfo":[{
  "NodeId":"r-xxxxxxxxxxxxxxx-proxy-3#5425423",
  "NodeType":"proxy",
   "Capacity":"5120",
   "Connection":"320000",
   "Bandwidth":96
                 }]},
  "InstanceId":"r-xxxxxxxxxxxxxxx",
  "RequestId":"5F749626-2B6A-4DC2-A010-B51F7C33084E"
 }

Error codes

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