首页 云数据库 Redis 开发参考 OpenAPI API参考 API目录 实例管理 DescribeClusterMemberInfo - 查询集群的节点配置信息

DescribeClusterMemberInfo - 查询集群的节点配置信息

更新时间: 2023-08-25 18:07:39

查询Redis集群实例的节点配置信息(例如规格、最大连接数等)。

接口说明

说明 本接口仅适用于云盘版实例集群架构)。

调试

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

调试

授权信息

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

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

请求参数

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

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

r-bp1zxszhcgatnx****
PageNumberinteger

实例列表的页码。

1
PageSizeinteger

每页可展示的最大记录数,取值:3050100,默认值为30

30

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

2D9F3768-EDA9-4811-943E-42C8006E****
ClusterChildrenobject []

集群实例的数据节点信息列表。

Capacitylong

单个数据节点的最大内存容量,单位为MB。

说明 Service返回值为redis(即节点类型为数据节点)时,才会返回本参数。
1024
UserIdstring

用户ID。

2****_176498472570****
DiskSizeMBinteger

数据节点ESSD云盘的存储空间,单位为MB。

说明 该ESSD云盘仅用作系统运行使用(例如数据持久化),不作为数据存取的介质。
4096
BandWidthlong

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

说明 Service返回值为redis(即节点类型为数据节点)时,才会返回本参数。
96
CurrentBandWidthlong

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

当Redis实例通过专属集群创建时,才会返回本参数。

100
ClassCodestring

数据节点的规格。更多信息,请参见云盘版实例规格

redis.shard.small.ce
BizTypestring

业务类型,返回值固定为ALIYUN

ALIYUN
Servicestring

节点类型,返回值:

  • redis:数据节点。
  • redis_cs:配置服务器节点。
redis
BinlogRetentionDaysinteger

binlog日志保存天数。

7
Connectionslong

数据节点的最大连接数。

20000
ResourceGroupNamestring

节点所属的资源组名称。

GLOBAL_ZHANGJIAKOU_A
ServiceVersionstring

节点的大版本。

5.0
ReplicaSizeinteger

子节点数。

0
Namestring

节点名称。

r-bp1zxszhcgatnx****-db-0
Idlong

节点的副本集ID。

501791111

示例

正常返回示例

JSON格式

{
  "RequestId": "2D9F3768-EDA9-4811-943E-42C8006E****",
  "ClusterChildren": [
    {
      "Capacity": 1024,
      "UserId": "2****_176498472570****",
      "DiskSizeMB": 4096,
      "BandWidth": 96,
      "CurrentBandWidth": 100,
      "ClassCode": "redis.shard.small.ce",
      "BizType": "ALIYUN",
      "Service": "redis",
      "BinlogRetentionDays": 7,
      "Connections": 20000,
      "ResourceGroupName": "GLOBAL_ZHANGJIAKOU_A",
      "ServiceVersion": "5.0",
      "ReplicaSize": 0,
      "Name": "r-bp1zxszhcgatnx****-db-0",
      "Id": 501791111
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-07-06OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PageNumber
    新增入参:PageSize
阿里云首页 云数据库 Redis 相关技术圈