AI 助理
备案控制台
文档
输入文档关键字查找
首页

DescribeDedicatedClusterInstanceList - 查看专属集群实例的列表

更新时间：
我的收藏

查询专属集群中的云数据库 Tair（兼容 Redis）实例信息。

接口说明

说明 如需查询非专属集群下的实例的信息，请调用 DescribeInstanceAttribute 。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
RegionIdstring是

地域 ID，您可以调用 DescribeRegions 查询。

cn-hangzhou
ZoneIdstring否

可用区 ID，您可以调用 DescribeZones 查询。

cn-hangzhou-e
InstanceIdstring否

实例 ID。

说明 该实例必须是通过专属集群创建的，更多信息，请参见云数据库专属集群 MyBase。
r-bp1zxszhcgatnx****
InstanceStatusinteger否

实例状态，取值：

  • 0：创建中。
  • 1：运行中。
  • 3：删除中。
  • 5：变配中。
  • 6：迁移中。
  • 7：备份恢复中。
  • 8：切换中。
  • 9：删除过期数据。
1
InstanceNetTypestring否

实例连接地址的网络类型，取值：

  • 0：公网。
  • 1：经典网络。
  • 2：专有网络 VPC。
2
Enginestring否

数据库类型，取值固定为 Redis。

Redis
EngineVersionstring否

数据库版本号，取值固定为5.0。

5.0
ClusterIdstring否

专属集群 ID，可在专属集群控制台的专属集群信息页获取。

说明 如需传入多个，ID 间使用英文逗号（,）分隔。
dhg-5f2v98840ioq****
DedicatedHostNamestring否

专属集群的主机 ID，可调用 DescribeDedicatedHosts 获取。

说明 如需传入多个，ID 间使用英文逗号（,）分隔。
ch-t4n664a9mal4c****
PageNumberinteger否

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

1
PageSizeinteger否

每页可展示的最大记录数，取值：30、50、100，默认值为 30。

30

返回参数

名称类型描述示例值
object
PageNumberinteger

页码。

1
PageSizeinteger

每页可展示的记录数。

25
RequestIdstring

请求 ID。

712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCountinteger

总记录数。

0
Instancesarray<object>

实例信息列表。

Instancesobject

实例信息列表。

VpcIdstring

专有网络 VPC ID。

vpc-t4n2clc70t3hqwsrr****
CharacterTypestring

架构类型，返回值：

  • logic：集群架构。
  • normal：标准架构。
logic
VswitchIdstring

虚拟交换机 ID。

vsw-t4nvrca24dczppq44****
InstanceClassstring

实例规格。

redis.cluster.sharding.common.ce
MaintainStartTimestring

可维护时间段的开始时间，格式为HH:mmZ（UTC 时间）。

16:00Z
CreateTimestring

实例的创建时间，格式为yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

2021-05-06T07:09:40Z
ConnectionDomainstring

直连地址。

r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com
MaintainEndTimestring

可维护时间段的结束时间，格式为HH:mmZ（UTC 时间）。

17:00Z
StorageTypestring

存储类型，返回值固定为 LOCAL_SSD（ ESSD 云盘）。

LOCAL_SSD
InstanceIdstring

实例 ID。

r-bp1e7vl6ygf1yq****
BandWidthlong

实例的默认带宽，单位为 MB/s。

24
CurrentBandWidthlong

实例当前的带宽，单位为 MB/s，由默认带宽和增加的带宽组成。

50
EngineVersionstring

数据库版本，返回值固定为5.0。

5.0
RegionIdstring

地域 ID。

cn-hangzhou
InstanceNamestring

实例名称。

testdb
ZoneIdstring

可用区 ID。

cn-hangzhou-e
ClusterNamestring

专属集群名称。

testname
InstanceStatusstring

实例状态，返回值：

  • Normal：正常。
  • Creating：创建中。
  • Changing：修改中。
  • Inactive：被禁用。
  • Flushing：清除中。
  • Released：已释放。
  • Transforming：转换中。
  • Unavailable：服务停止。
  • Error：创建失败。
  • Migrating：迁移中。
  • BackupRecovering：备份恢复中。
  • MinorVersionUpgrading：小版本升级中。
  • NetworkModifying：网络变更中。
  • SSLModifying：SSL 变更中。
  • MajorVersionUpgrading：大版本升级中，可正常访问。
Normal
Enginestring

数据库类型，返回值固定为 redis。

redis
ShardCountinteger

数据分片数量。

说明 仅当实例为集群架构时，才会返回本参数。
3
CustomIdstring

内部参数，维护实例使用。

4652****
ProxyCountinteger

代理节点数量。

说明
  • 返回值为 0 时，表示实例未开启代理模式；返回值为大于 0 的整数时（例如 1），表示实例已开启代理模式。
  • 仅当实例为集群架构时，才会返回本参数。
    •
    		1
    ClusterIdstring

    专属集群 ID。

    		dhg-rx71fc5ndh9o****
    InstanceNodeListarray<object>

    节点信息列表。

    InstanceNodesobject

    实例节点的列表。

    NodeIpstring

    节点 IP 地址。

    		10.0.33.***
    DedicatedHostNamestring

    专属集群的主机 ID。

    		ch-bp13vf0y9gx3c****
    NodeTypestring

    节点类型，返回值：

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

    节点所属的可用区。

    		cn-hangzhou-h
    InstanceIdstring

    实例 ID。

    		r-bp1e7vl6ygf1yq****
    Portinteger

    节点的端口。

    		3001
    Rolestring

    节点角色，返回值：

    • master：主节点。
    • slave：从节点。
    		master
    NodeIdinteger

    节点 ID。

    		17921111

    示例

    正常返回示例

    JSON格式

    {
  "PageNumber": 1,
  "PageSize": 25,
  "RequestId": "712CCF2A-16BD-411B-93F7-E978BEF2****",
  "TotalCount": 0,
  "Instances": [
    {
      "VpcId": "vpc-t4n2clc70t3hqwsrr****",
      "CharacterType": "logic",
      "VswitchId": "vsw-t4nvrca24dczppq44****",
      "InstanceClass": "redis.cluster.sharding.common.ce",
      "MaintainStartTime": "16:00Z",
      "CreateTime": "2021-05-06T07:09:40Z",
      "ConnectionDomain": "r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com",
      "MaintainEndTime": "17:00Z",
      "StorageType": "LOCAL_SSD",
      "InstanceId": "r-bp1e7vl6ygf1yq****",
      "BandWidth": 24,
      "CurrentBandWidth": 50,
      "EngineVersion": "5.0",
      "RegionId": "cn-hangzhou",
      "InstanceName": "testdb",
      "ZoneId": "cn-hangzhou-e",
      "ClusterName": "testname",
      "InstanceStatus": "Normal",
      "Engine": "redis",
      "ShardCount": 3,
      "CustomId": "4652****",
      "ProxyCount": 1,
      "ClusterId": "dhg-rx71fc5ndh9o****",
      "InstanceNodeList": [
        {
          "NodeIp": "10.0.33.***",
          "DedicatedHostName": "ch-bp13vf0y9gx3c****",
          "NodeType": "normal",
          "ZoneId": "cn-hangzhou-h",
          "InstanceId": "r-bp1e7vl6ygf1yq****",
          "Port": 3001,
          "Role": "master",
          "NodeId": 17921111
        }
      ]
    }
  ]
}

    错误码

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