DescribeDedicatedClusterInstanceList_云数据库 Tair(兼容 Redis®)_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

请求速率为1000/1(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
kvstore:DescribeDedicatedClusterInstanceList
Get
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

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

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

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

示例值:cn-hangzhou-e参考取值来源:
    DescribeZones
InstanceIdstring

实例 ID。展开详情

示例值:r-bp1zxszhcgatnx****参考取值来源:
    CreateInstance
    ModifyInstanceSSL
    RestartInstance
    RestoreInstance
    DescribeInstances
InstanceStatusinteger<int32>

实例状态,取值:展开详情

示例值:1
InstanceNetTypestring

实例连接地址的网络类型,取值:展开详情

示例值:2参考取值来源:
    ModifyInstanceNetExpireTime
    DescribeDBInstanceNetInfo
Enginestring

数据库类型,取值固定为 Redis

示例值:Redis枚举值:Redis参考取值来源:
    DescribeEngineVersion
EngineVersionstring

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

示例值:5.0枚举值:5.06.0
ClusterIdstring

专属集群 ID,可在专属集群控制台的专属集群信息页获取。展开详情

示例值:dhg-5f2v98840ioq****
DedicatedHostNamestring

专属集群的主机 ID,可调用 DescribeDedicatedHosts 获取。展开详情

示例值:ch-t4n664a9mal4c****
PageNumberinteger<int32>

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

示例值:1取值 >= 1
PageSizeinteger<int32>

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

示例值:30枚举值:3050100

返回参数

字段名称字段详情
PageNumberinteger<int32>

页码。

示例值:1
PageSizeinteger<int32>

每页可展示的记录数。

示例值:25
RequestIdstring

请求 ID。

示例值:712CCF2A-16BD-411B-93F7-E978BEF2****
TotalCountinteger<int32>

总记录数。

示例值:0
Instancesarray<object>

实例信息列表。

返回示例

变更历史

变更时间变更内容概要操作
2021-12-13
变更请求参数InstanceId
变更请求参数InstanceStatus
变更请求参数InstanceNetType
变更请求参数Engine
变更请求参数EngineVersion
变更请求参数ClusterId
变更请求参数DedicatedHostName
变更请求参数PageNumber
变更请求参数PageSize
新增请求参数ZoneId

相关示例

查询专属集群中的Redis实例信息
2021-11-29