全部产品
Search
文档中心

云原生内存数据库Tair:DescribeLogicInstanceTopology - 查询Redis实例的逻辑拓扑结构

更新时间:Jun 18, 2024

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

接口说明

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeLogicInstanceTopologyRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
InstanceIdstring

实例的 ID。

r-bp1zxszhcgatnx****
RequestIdstring

请求 ID。

794120D1-E0CF-4713-BAE4-EBAEA04506AF
RedisProxyListobject []

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

Capacitystring

节点的容量,单位为 MB。

5120
Connectionstring

连接数限制。

320000
NodeTypestring

节点类型,返回值:

  • db:数据节点。
  • normal:管理节点,由 Proxy 节点(代理节点)和 CS 节点(配置管理节点)组成。部分实例不会返回 normal,而是分别返回 proxy 和 cs。
proxy
Bandwidthstring

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

96
NodeIdstring

节点 ID。

r-bp10noxlhcoim2****-proxy-3#542****
RedisShardListobject []

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

Capacitystring

节点的容量,单位为 MB。

2048
Connectionstring

连接数限制。

10000
NodeTypestring

节点类型,返回值:

  • proxy:代理节点。
  • db:数据节点。
db
Bandwidthstring

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

96
NodeIdstring

节点 ID。

r-bp10noxlhcoim2****-db-0#688****
SubInstanceTypestring

子实例类型,返回值:

  • master:主节点类型。
  • readonly:只读实例类型。
master

示例

正常返回示例

JSON格式

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "794120D1-E0CF-4713-BAE4-EBAEA04506AF",
  "RedisProxyList": {
    "NodeInfo": [
      {
        "Capacity": "5120",
        "Connection": "320000",
        "NodeType": "proxy",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-proxy-3#542****"
      }
    ]
  },
  "RedisShardList": {
    "NodeInfo": [
      {
        "Capacity": "2048",
        "Connection": "10000",
        "NodeType": "db",
        "Bandwidth": "96",
        "NodeId": "r-bp10noxlhcoim2****-db-0#688****",
        "SubInstanceType": "master"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-21OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更