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

仅集群与读写分离架构实例支持本接口。

调试

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

请求参数

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

系统规定参数。取值:DescribeLogicInstanceTopology

RegionId String cn-hangzhou

实例所属的地域ID。

InstanceId String r-bp1zxszhcgatnx****

实例ID。

返回数据

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

实例的ID。

RequestId String 794120D1-E0CF-4713-BAE4-EBAEA04506AF

请求ID。

RedisProxyList Array of NodeInfo

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

NodeInfo
Capacity String 5120

节点的容量,单位为MB。

Connection String 320000

连接数限制。

NodeType String proxy

节点类型,返回值:

  • proxy:代理节点。
  • db:数据节点。
Bandwidth String 96

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

NodeId String r-bp10noxlhcoim2****-proxy-3#542****

节点ID。

RedisShardList Array of NodeInfo

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

NodeInfo
Capacity String 2048

节点的容量,单位为MB。

Connection String 10000

连接数限制。

NodeType String db

节点类型,返回值:

  • proxy:代理节点。
  • db:数据节点。
Bandwidth String 96

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

NodeId String r-bp10noxlhcoim2****-db-0#688****

节点ID。

示例

请求示例

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

正常返回示例

XML格式

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

<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格式

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

{
  "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"
    } ]
  }
}

错误码

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