调用DescribeLogicInstanceTopology查询Redis实例的逻辑拓扑结构。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 位置 类型 是否必选 示例值 描述
Action Query String DescribeLogicInstanceTopology

系统规定参数,取值:DescribeLogicInstanceTopology。

InstanceId Query String r-bp1xxxxxxxxxxxxx

实例ID。

返回数据

名称 类型 示例值 描述
InstanceId String r-bp1xxxxxxxxxxxxx

实例的ID。

RedisProxyList Array of NodeInfo

代理详情,包含代理节点信息。

NodeInfo
Bandwidth String 96

节点的带宽限制,单位为MB/s。

Capacity String 5120

节点的容量,单位为MB。

Connection String 320000

连接数限制。

NodeId String r-xxxxxxxxxxxxxxx-proxy-3#5425423

节点ID。

NodeType String proxy

节点类型,取值:

  • proxy(代理节点)
  • db(数据节点)
RedisShardList Array of NodeInfo

分片详情,包含NodeInfo等子节点信息 。

NodeInfo
Bandwidth String 96

节点的带宽限制,单位为MB/s。

Capacity String 2048

节点的容量,单位为MB。

Connection String 10000

连接数限制。

NodeId String r-bp1xxxxxxxxxxxxx-db-0#6889415

节点ID。

NodeType String proxy

节点类型,取值:

  • proxy(代理节点)
  • db(数据节点)
RequestId String 794120D1-E0CF-4713-BAE4-EBAEA04506AF

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/
?Action=DescribeLogicInstanceTopology
&InstanceId=r-bp1xxxxxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RedisShardList>
    <NodeInfo>
        <Capacity>512</Capacity>
        <Bandwidth>24</Bandwidth>
        <NodeType>db</NodeType>
        <NodeId>r-bp********-db-0#***89285</NodeId>
        <Connection>50000</Connection>
    </NodeInfo>
    <NodeInfo>
        <Capacity>512</Capacity>
        <Bandwidth>24</Bandwidth>
        <NodeType>db</NodeType>
        <NodeId>r-bp********-db-1#***89281</NodeId>
        <Connection>50000</Connection>
    </NodeInfo>
</RedisShardList>
<RequestId>794120D1-E0CF-4713-BAE4-EBAEA04506AF</RequestId>
<InstanceId>r-bp********</InstanceId>
<RedisProxyList>
    <NodeInfo>
        <Capacity>5120</Capacity>
        <Bandwidth>96</Bandwidth>
        <NodeType>proxy</NodeType>
        <NodeId>r-bp********-proxy-0#***89291</NodeId>
        <Connection>10000</Connection>
    </NodeInfo>
    <NodeInfo>
        <Capacity>5120</Capacity>
        <Bandwidth>96</Bandwidth>
        <NodeType>proxy</NodeType>
        <NodeId>r-bp********-proxy-1#***89275</NodeId>
        <Connection>10000</Connection>
    </NodeInfo>
    <NodeInfo>
        <Capacity>5120</Capacity>
        <Bandwidth>96</Bandwidth>
        <NodeType>proxy</NodeType>
        <NodeId>r-bp********-proxy-2#***89273</NodeId>
        <Connection>10000</Connection>
    </NodeInfo>
    <NodeInfo>
        <Capacity>5120</Capacity>
        <Bandwidth>96</Bandwidth>
        <NodeType>proxy</NodeType>
        <NodeId>r-bp********-proxy-3#***89279</NodeId>
        <Connection>10000</Connection>
    </NodeInfo>
</RedisProxyList>

JSON 格式

{
	"RedisShardList": {
		"NodeInfo": [
			{
				"Capacity": "512",
				"Bandwidth": 24,
				"NodeType": "db",
				"NodeId": "r-bp********-db-0#***89285",
				"Connection": "50000"
			},
			{
				"Capacity": "512",
				"Bandwidth": 24,
				"NodeType": "db",
				"NodeId": "r-bp********-db-1#***89281",
				"Connection": "50000"
			}
		]
	},
	"RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
	"InstanceId": "r-bp********",
	"RedisProxyList": {
		"NodeInfo": [
			{
				"Capacity": "5120",
				"Bandwidth": 96,
				"NodeType": "proxy",
				"NodeId": "r-bp********-proxy-0#***89291",
				"Connection": "10000"
			},
			{
				"Capacity": "5120",
				"Bandwidth": 96,
				"NodeType": "proxy",
				"NodeId": "r-bp********-proxy-1#***89275",
				"Connection": "10000"
			},
			{
				"Capacity": "5120",
				"Bandwidth": 96,
				"NodeType": "proxy",
				"NodeId": "r-bp********-proxy-2#***89273",
				"Connection": "10000"
			},
			{
				"Capacity": "5120",
				"Bandwidth": 96,
				"NodeType": "proxy",
				"NodeId": "r-bp********-proxy-3#***89279",
				"Connection": "10000"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。