Queries the logical topology of an ApsaraDB for Redis instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeLogicInstanceTopology |
The operation that you want to perform. Set the value to DescribeLogicInstanceTopology. |
InstanceId | String | Yes | r-bp1zxszhcgatnx**** |
The ID of the instance. |
RegionId | String | No | cn-hangzhou |
The ID of the region where the instance is deployed. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
InstanceId | String | r-bp1zxszhcgatnx**** |
The ID of the instance. |
RedisProxyList | Array of NodeInfo |
The detailed proxy information, including information about proxy nodes. |
|
NodeInfo | |||
Bandwidth | String | 96 |
The bandwidth throttling of the node. Unit: MB/s. |
Capacity | String | 5120 |
The storage capacity of the node. Unit: MB. |
Connection | String | 320000 |
The maximum number of connections. |
NodeId | String | r-bp10noxlhcoim2****-proxy-3#542**** |
The ID of the node. |
NodeType | String | proxy |
The type of node. Valid values:
|
RedisShardList | Array of NodeInfo |
The detailed shard information, including node information such as NodeInfo. |
|
NodeInfo | |||
Bandwidth | String | 96 |
The bandwidth throttling of the node. Unit: MB/s. |
Capacity | String | 2048 |
The storage capacity of the node. Unit: MB. |
Connection | String | 10000 |
The maximum number of connections. |
NodeId | String | r-bp10noxlhcoim2****-db-0#688**** |
The ID of the node. |
NodeType | String | db |
The type of node. Valid values:
|
RequestId | String | 794120D1-E0CF-4713-BAE4-EBAEA04506AF |
The ID of the request. |
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=DescribeLogicInstanceTopology
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>
Sample success responses
XML
format
<DescribeLogicInstanceTopologyResponse>
<RedisShardList>
<NodeInfo>
<Capacity>2048</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>db</NodeType>
<NodeId>r-bp10noxlhcoim2****-db-0#14965569</NodeId>
<Connection>30000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>2048</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>db</NodeType>
<NodeId>r-bp10noxlhcoim2****-db-1#14965575</NodeId>
<Connection>30000</Connection>
</NodeInfo>
</RedisShardList>
<RequestId>B5250FA2-CB49-4B68-9263-721099AC928A</RequestId>
<InstanceId>r-bp10noxlhcoim2****</InstanceId>
<RedisProxyList>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-0#14965583</NodeId>
<Connection>20000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-1#14965585</NodeId>
<Connection>20000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-2#14965587</NodeId>
<Connection>20000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-3#14965589</NodeId>
<Connection>20000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-4#14965591</NodeId>
<Connection>20000</Connection>
</NodeInfo>
<NodeInfo>
<Capacity>5120</Capacity>
<Bandwidth>96</Bandwidth>
<NodeType>proxy</NodeType>
<NodeId>r-bp10noxlhcoim2****-proxy-5#14965571</NodeId>
<Connection>20000</Connection>
</NodeInfo>
</RedisProxyList>
</DescribeLogicInstanceTopologyResponse>
JSON
format
{
"RedisShardList": {
"NodeInfo": [
{
"Capacity": "2048",
"Bandwidth": 96,
"NodeType": "db",
"NodeId": "r-bp10noxlhcoim2****-db-0#14965569",
"Connection": "30000"
},
{
"Capacity": "2048",
"Bandwidth": 96,
"NodeType": "db",
"NodeId": "r-bp10noxlhcoim2****-db-1#14965575",
"Connection": "30000"
}
]
},
"RequestId": "B5250FA2-CB49-4B68-9263-721099AC928A",
"InstanceId": "r-bp10noxlhcoim2****",
"RedisProxyList": {
"NodeInfo": [
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-0#14965583",
"Connection": "20000"
},
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-1#14965585",
"Connection": "20000"
},
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-2#14965587",
"Connection": "20000"
},
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-3#14965589",
"Connection": "20000"
},
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-4#14965591",
"Connection": "20000"
},
{
"Capacity": "5120",
"Bandwidth": 96,
"NodeType": "proxy",
"NodeId": "r-bp10noxlhcoim2****-proxy-5#14965571",
"Connection": "20000"
}
]
}
}
Error codes
For a list of error codes, visit the API Error Center.