调用DescribeInstances查询一个或多个Redis实例的信息。

调试

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

请求参数

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

系统规定参数，取值：DescribeInstances。

RegionId String 是 cn-hangzhou

实例所属的地域ID。

说明 调用本接口时，如果传入了 Tag.N.Key和 Tag.N.Value参数，则本参数必须传入。
InstanceIds String 否 r-bp1zxszhcgatnx****

需要查询的实例ID。

说明 如需传入多个实例ID时，使用英文逗号（,）分隔实例ID。
InstanceStatus String 否 Normal

实例状态，取值：

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

付费类型，取值：

  • PrePaid：预付费，即包年包月。
  • PostPaid：后付费，即按量付费。
NetworkType String 否 CLASSIC

网络类型，取值：

  • CLASSIC：经典网络。
  • VPC：专有网络。
EngineVersion String 否 4.0

Redis实例的引擎版本，取值：2.8、4.0、5.0或6.0。

InstanceClass String 否 redis.master.small.default

实例规格，请参见实例规格表。

VpcId String 否 vpc-bp1nme44gek34slfc****

专有网络ID。
VSwitchId String 否 vsw-bp1e7clcw529l773d****

虚拟交换机ID。
PageNumber Integer 否 1

实例列表的页码，起始值为1，默认值为1。

PageSize Integer 否 10

每页最多可显示的行数，最大值为50，默认值为10。

InstanceType String 否 Redis

引擎类型，取值：

  • Redis。
  • Memcache。
SearchKey String 否 apitest

实例名称。
ArchitectureType String 否 standard

架构类型，取值：

  • cluster：集群版。
  • standard：标准版。
  • rwsplit：读写分离版。
Expired String 否 false

实例的过期状态，取值：

  • true：已过期。
  • false：未过期。
ZoneId String 否 cn-hongkong-b

可用区ID。
Tag.N.Key String 否 {“key1”:”value1”,“key2”:”value2”}

标签的键，与Tag Value组成标签的键值对，格式为{"key1":"value1","key2":"value2"}。

说明 单次最多支持传入5组标签的键值对。
Tag.N.Value String 否 {“key1”:”value1”,“key2”:”value2”}

标签键的值，与Tag Key组成标签的键值对。
ResourceGroupId String 否 rg-acfmyiu4ekp****

资源组ID。

说明 您可以通过调用 ListResourceGroups接口或通过控制台获取资源组ID列表。相关操作，请参见 查看资源组基本信息。
GlobalInstance Boolean 否 true

返回的实例列表中，是否过滤分布式实例中的子实例，取值：

  • true：只返回子实例信息。
  • false：不返回子实例信息。
EditionType String 否 Enterprise

实例类型，取值：

  • Community：社区版。
  • Enterprise：企业版。
PrivateIp String 否 172.16.49.***

专有网络IP地址。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

实例总个数。
PageNumber Integer 1

实例列表的页码。
PageSize Integer 30

输入时设置的每页行数。
Instances Array of KVStoreInstance

由Instance组成的集合。
KVStoreInstance
ArchitectureType String cluster

架构类型，返回值：

  • cluster：集群版。
  • standard：标准版。
  • SplitRW：读写分离版。
  • NULL：所有类型，默认值。
Bandwidth Long 96

实例带宽，单位：MB/s。
Capacity Long 4096

实例容量， 单位：MB。
ChargeType String PostPaid

付费类型，返回值：

  • PrePaid：预付费。
  • PostPaid：后付费。
Config String {\"maxmemory-policy\":\"volatile-lfu\",\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64,\"#no_loose_disabled-commands\":\"flushall,flushdb\",\"lazyfree-lazy-eviction\":\"yes\"}

实例的参数设置情况，详情请参见参数设置。

ConnectionDomain String r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

实例的内网连接地址。
ConnectionMode String Standard

实例的访问模式，返回值：

  • Standard：标准访问模式。
  • Safe：数据库代理模式。
Connections Long 20000

实例的连接数限制。
CreateTime String 2018-11-07T08:49:00Z

实例的创建时间。
DestroyTime String 2019-04-28T10:03:01Z

销毁实例的时间。
EndTime String 2019-06-13T16:00:00Z

包年包月实例到期时间。
EngineVersion String 4.0

Redis实例的引擎版本，返回值：2.8、4.0、5.0或6.0。

GlobalInstanceId String gr-bp14rkqrhac****

分布式实例ID。

说明 当实例为分布式实例中的子实例时，才会返回该参数。
HasRenewChangeOrder Boolean false

是否有未生效的续费变配订单，返回值：

  • true：是。
  • false：否。
InstanceClass String redis.logic.sharding.2g.2db.0rodb.4proxy.default

实例的规格。
InstanceId String r-bp1zxszhcgatnx****

实例的ID。
InstanceName String apitest

实例的名称。
InstanceStatus String Normal

实例的状态。
InstanceType String Redis

实例类型。
IsRds Boolean true

是否属RDS管控，返回值：

  • true：是。
  • false：否。
NetworkType String CLASSIC

网络类型，返回值：

  • CLASSIC：经典网络。
  • VPC：专有网络。
NodeType String double

节点类型，返回值：

  • double：双副本。
  • single：单副本（已下线）。
PackageType String standard

套餐类型，返回值：

  • standard：标准套餐。
  • customized：定制套餐。
Port Long 6379

Redis服务端口。
PrivateIp String 172.16.49.***

专有网络IP地址。

说明 实例的网络类型为经典网络时，不会返回本参数。
QPS Long 100000

每秒请求数（Queries per Second）。
RegionId String cn-hangzhou

地域ID。
ReplacateId String grr-bp11381ebc16****

多活实例的逻辑ID。
ResourceGroupId String rg-acfmyiu4ekp****

实例所属的资源组ID。
SearchKey String apitest

基于实例ID或者实例备注模糊搜索时使用的关键字。
SecondaryZoneId String cn-hangzhou-h

备可用区ID。
ShardCount Integer 3

集群的数据节点数量。

说明 当Redis实例为云盘版（集群架构）时才会返回本参数。
Tags Array of Tag

标签信息。
Tag
Key String key1

Tag的Key。
Value String value1

Tag的Value。
UserName String r-bp1zxszhcgatnx****

连接使用的用户名，默认包含有一个以实例ID命名的用户名。
VSwitchId String vsw-bp1e7clcw529l773d****

虚拟交换机的ID。
VpcId String vpc-bp1nme44gek34slfc****

专有网络（VPC）的ID。
ZoneId String cn-hangzhou-b

可用区ID。
RequestId String 1E83311F-0EE4-4922-A3BF-730B312B****

请求ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式 

<DescribeInstancesResponse>
      <Instances>
            <KVStoreInstance>
                  <Connections>10000</Connections>
                  <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
                  <Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
                  <Port>6379</Port>
                  <HasRenewChangeOrder>false</HasRenewChangeOrder>
                  <ConnectionDomain>r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com</ConnectionDomain>
                  <Capacity>1024</Capacity>
                  <QPS>80000</QPS>
                  <PrivateIp>172.16.49.***</PrivateIp>
                  <InstanceStatus>Normal</InstanceStatus>
                  <NetworkType>VPC</NetworkType>
                  <Bandwidth>10</Bandwidth>
                  <PackageType>standard</PackageType>
                  <InstanceType>Redis</InstanceType>
                  <Tags>
                        <Tag>
                              <Value>社区版</Value>
                              <Key>类型</Key>
                        </Tag>
                  </Tags>
                  <ArchitectureType>standard</ArchitectureType>
                  <UserName>r-bp1wcw2rlw76ac****</UserName>
                  <EngineVersion>5.0</EngineVersion>
                  <ZoneId>cn-hangzhou-f</ZoneId>
                  <InstanceId>r-bp1wcw2rlw76ac****</InstanceId>
                  <VSwitchId>vsw-bp1w9ouei2nm66qlz****</VSwitchId>
                  <CreateTime>2020-03-31T06:56:22Z</CreateTime>
                  <InstanceClass>redis.master.small.default</InstanceClass>
                  <IsRds>true</IsRds>
                  <InstanceName>社区主从50</InstanceName>
                  <VpcId>vpc-bp1opxu1zkhn00gzv****</VpcId>
                  <ChargeType>PostPaid</ChargeType>
                  <NodeType>double</NodeType>
                  <RegionId>cn-hangzhou</RegionId>
            </KVStoreInstance>
      </Instances>
      <TotalCount>1</TotalCount>
      <RequestId>78DDAA9A-B09E-4BE0-AEAE-10A22924****</RequestId>
      <PageSize>30</PageSize>
      <PageNumber>1</PageNumber>
</DescribeInstancesResponse>

JSON格式 

{
	"Instances": {
		"KVStoreInstance": [
			{
				"Connections": 10000,
				"ResourceGroupId": "rg-acfmyiu4ekp****",
				"Config": "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
				"Port": 6379,
				"HasRenewChangeOrder": false,
				"ConnectionDomain": "r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com",
				"Capacity": 1024,
				"QPS": 80000,
				"PrivateIp": "172.16.49.***",
				"InstanceStatus": "Normal",
				"NetworkType": "VPC",
				"Bandwidth": 10,
				"PackageType": "standard",
				"InstanceType": "Redis",
				"Tags": {
					"Tag": [
						{
							"Value": "社区版",
							"Key": "类型"
						}
					]
				},
				"ArchitectureType": "standard",
				"UserName": "r-bp1wcw2rlw76ac****",
				"EngineVersion": "5.0",
				"ZoneId": "cn-hangzhou-f",
				"InstanceId": "r-bp1wcw2rlw76ac****",
				"VSwitchId": "vsw-bp1w9ouei2nm66qlz****",
				"CreateTime": "2020-03-31T06:56:22Z",
				"InstanceClass": "redis.master.small.default",
				"IsRds": true,
				"InstanceName": "社区主从50",
				"VpcId": "vpc-bp1opxu1zkhn00gzv****",
				"ChargeType": "PostPaid",
				"NodeType": "double",
				"RegionId": "cn-hangzhou"
			}
		]
	},
	"TotalCount": 1,
	"RequestId": "78DDAA9A-B09E-4BE0-AEAE-10A22924****",
	"PageSize": 30,
	"PageNumber": 1
}

错误码

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