文档

DescribeRoleZoneInfo - 查询节点和所属可用区信息

更新时间:

查询Redis实例中各节点的角色、类型、小版本和所属的可用区。

调试

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

授权信息

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

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

请求参数

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

实例 ID,可调用 DescribeInstances 接口获取。

r-t4nlenc2p04uvb****
QueryTypeinteger

查询的目标节点类型,取值:

  • 0:Proxy(代理)节点。

    说明 该参数仅支持集群与读写分离架构实例。
  • 1:数据节点,默认值。

0
PageNumberinteger

页码,大于 0 且不超过 Integer 数据类型的最大值,默认值为 1

1
PageSizeinteger

每页可展示的记录数,取值:102050,默认值为 10.

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

224B97FB-A275-4EAC-86E9-8922FEA2****
PageNumberinteger

页码。

1
PageSizeinteger

每页可展示的记录数。

10
TotalCountinteger

总记录数。

2
Nodearray<object>

Redis 实例中各节点的详细信息。

NodeInfoobject
DefaultBandWidthlong

节点默认的默认带宽,单位为 MB/s。

96
CurrentMinorVersionstring

节点当前的小版本。

redis-5.0_0.3.10
CurrentBandWidthlong

节点当前的带宽,单位为 MB/s,由节点的默认带宽和增加的带宽组成。

说明
  • 您可以调用 EnableAdditionalBandwidth 接口设置要增加的带宽。
  • 通过本参数也可推算出增加的带宽大小,例如节点默认带宽为 96 MB/s,本参数返回值为 100,则增加了 4 MB/s 的带宽。
  • 100
    InsTypeinteger

    是否为只读节点,如果为只读节点,本参数返回值为 3

    说明 如果不是只读节点,不返回本参数。
    3
    IsLatestVersioninteger

    是否为最新的小版本,返回值:

    • 0:不是最新版本。
    • 1:是最新版本。
    说明 如需升级小版本,请调用 ModifyInstanceMinorVersion 接口。
    1
    InsNamestring

    节点 ID。

    r-t4nlenc2p04uvb****
    NodeTypestring

    节点类型,返回值:

    • db:数据节点。
    • proxy:代理节点。
    • normal:普通节点(标准架构的实例会返回该值)。
    normal
    ZoneIdstring

    可用区 ID。

    cn-hangzhou-b
    IsOpenBandWidthServiceboolean

    该节点是否增加了带宽,取值:

    • true:未增加带宽。
    • false:已增加带宽。
    true
    CustinsIdstring

    数据分片节点 ID。

    30381****
    Rolestring

    节点角色,返回值:

    • master:主节点。
    • slave:从节点。
    master
    NodeIdstring

    本参数仅作为 Redis 实例内部维护使用。

    10065****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
      "PageNumber": 1,
      "PageSize": 10,
      "TotalCount": 2,
      "Node": {
        "NodeInfo": [
          {
            "DefaultBandWidth": 96,
            "CurrentMinorVersion": "redis-5.0_0.3.10",
            "CurrentBandWidth": 100,
            "InsType": 3,
            "IsLatestVersion": 1,
            "InsName": "r-t4nlenc2p04uvb****",
            "NodeType": "normal",
            "ZoneId": "cn-hangzhou-b",
            "IsOpenBandWidthService": true,
            "CustinsId": "30381****",
            "Role": "master",
            "NodeId": "10065****"
          }
        ]
      }
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2024-09-26API 内部配置变更,不影响调用查看变更详情