调用DescribeDedicatedClusterInstanceList查询专属集群中的Redis实例信息。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDedicatedClusterInstanceList

要执行的操作,取值:DescribeDedicatedClusterInstanceList

RegionId String cn-hangzhou

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

ZoneId String cn-hangzhou-e

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

InstanceId String r-bp1zxszhcgatnx****

实例ID。

说明 该实例必须是通过专属集群创建的,更多信息,请参见云数据库专属集群MyBase
InstanceStatus Integer 1

实例状态,取值:

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

实例连接地址的网络类型,取值:

  • 0:公网。
  • 1:经典网络。
  • 2:专有网络VPC。
Engine String Redis

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

EngineVersion String 5.0

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

ClusterId String dhg-5f2v98840ioq****

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

说明 如需传入多个,ID间使用英文逗号(,)分隔。
DedicatedHostName String ch-t4n664a9mal4c****

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

说明 如需传入多个,ID间使用英文逗号(,)分隔。
PageNumber Integer 1

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

PageSize Integer 30

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

返回数据

名称 类型 示例值 描述
Instances Array of Instances

实例信息列表。

BandWidth Long 24

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

CharacterType String logic

架构类型,返回值:

  • logic:集群架构。
  • normal:标准架构。
ClusterId String dhg-rx71fc5ndh9o****

专属集群ID。

ClusterName String testname

专属集群名称。

ConnectionDomain String r-t4ncdi1dgi0ja8****.redis.hangzhou.rds.aliyuncs.com

直连地址。

CreateTime String 2021-05-06T07:09:40Z

实例的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

CurrentBandWidth Long 50

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

CustomId String 4652****

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

Engine String redis

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

EngineVersion String 5.0

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

InstanceClass String redis.cluster.sharding.common.ce

实例规格。

InstanceId String r-bp1e7vl6ygf1yq****

实例ID。

InstanceName String testdb

实例名称。

InstanceNodeList Array of InstanceNodes

节点信息列表。

DedicatedHostName String ch-bp13vf0y9gx3c****

专属集群的主机ID。

InstanceId String r-bp1e7vl6ygf1yq****

Redis实例ID。

NodeId Integer 17921111

节点ID。

NodeIp String 10.0.33.***

节点IP地址。

NodeType String normal

节点类型,返回值:

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

节点的端口。

Role String master

节点角色,返回值:

  • master:主节点。
  • slave:从节点。
ZoneId String cn-hangzhou-h

节点所属的可用区。

InstanceStatus String Normal

实例状态,返回值:

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

可维护时间段的结束时间,格式为HH:mmZ(UTC时间)。

MaintainStartTime String 16:00Z

可维护时间段的开始时间,格式为HH:mmZ(UTC时间)。

ProxyCount Integer 1

代理节点数量。

说明
  • 返回值为0时,表示实例未开启代理模式;返回值为大于0的整数时(例如1),表示实例已开启代理模式。
  • 仅当Redis实例为集群架构时,才会返回本参数。
RegionId String cn-hangzhou

地域ID。

ShardCount Integer 3

数据分片数量。

说明 仅当Redis实例为集群架构时,才会返回本参数。
StorageType String LOCAL_SSD

存储类型,返回值固定为LOCAL_SSD(ESSD云盘)。

VpcId String vpc-t4n2clc70t3hqwsrr****

专有网络VPC ID。

VswitchId String vsw-t4nvrca24dczppq44****

虚拟交换机ID。

ZoneId String cn-hangzhou-e

可用区ID。

PageNumber Integer 1

页码。

PageSize Integer 30

每页可展示的记录数。

RequestId String 712CCF2A-16BD-411B-93F7-E978BEF2****

请求ID。

TotalCount Integer 1

总记录数。

示例

请求示例

http(s)://r-kvstore.aliyuncs.com/?Action=DescribeDedicatedClusterInstanceList
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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