调用DescribeInstances查询实例的列表信息-阿里云帮助中心

查询一个或多个云数据库 Tair（兼容 Redis）实例的信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
kvstore:DescribeInstances	list	DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/` *DBInstance `acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所属的地域 ID。说明调用本接口时，如果传入了 Tag 参数，则本参数必须传入。	cn-hangzhou
InstanceIds	string	否	需要查询的实例 ID。说明如需传入多个实例 ID 时，使用英文逗号（,）分隔实例 ID，最多一个请求传入 30 个实例 ID。	r-bp1zxszhcgatnx****
InstanceStatus	string	否	实例状态，取值： Normal：正常。 Creating：创建中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已释放。 Transforming：转换中。 Unavailable：服务停止。 Error：创建失败。 Migrating：迁移中。 BackupRecovering：备份恢复中。 MinorVersionUpgrading：小版本升级中。 NetworkModifying：网络变更中。 SSLModifying：SSL 变更中。 MajorVersionUpgrading：大版本升级中，可正常访问。说明更多实例状态及详细信息，请参见实例状态与影响。	Normal
ChargeType	string	否	付费类型，取值： PrePaid：预付费，即包年包月。 PostPaid：后付费，即按量付费。	PostPaid
NetworkType	string	否	网络类型，取值： CLASSIC：经典网络。 VPC：专有网络。	CLASSIC
EngineVersion	string	否	Redis 实例的引擎版本，取值：2.8、4.0、5.0或6.0。	4.0
InstanceClass	string	否	实例规格，请参见实例规格表。	redis.master.small.default
VpcId	string	否	专有网络 ID。	vpc-bp1nme44gek34slfc****
VSwitchId	string	否	虚拟交换机 ID。	vsw-bp1e7clcw529l773d****
PageNumber	integer	否	实例列表的页码，起始值为 1，默认值为 1。	1
PageSize	integer	否	每页最多可显示的行数，最大值为 50，默认值为 30。	30
InstanceType	string	否	实例类型，取值： Tair。 Redis。 Memcache。	Redis
SearchKey	string	否	支持模糊搜索实例名称或实例 ID。	apitest
ArchitectureType	string	否	架构类型，取值： cluster：集群版。 standard：标准版。 rwsplit：读写分离版。	standard
Expired	string	否	实例的过期状态，取值： true：已过期。 false：未过期。	false
ZoneId	string	否	可用区 ID。	cn-hongkong-b
ResourceGroupId	string	否	资源组 ID。说明您可以通过调用 ListResourceGroups 接口或通过控制台获取资源组 ID 列表。相关操作，请参见查看资源组基本信息。	rg-acfmyiu4ekp****
GlobalInstance	boolean	否	返回的实例列表中，是否过滤分布式实例中的子实例，取值： true：只返回子实例信息。 false：不返回子实例信息。	true
EditionType	string	否	实例类型，取值： Community：社区版。 Enterprise：企业版。	Enterprise
PrivateIp	string	否	专有网络 IP 地址。	172.16.49.***
Tag	array<object>	否	实例的标签信息。
	object	否	对象。
Key	string	否	标签的键，与 Tag Value 组成标签的键值对。说明单次最多支持传入 5 组标签的键值对。	存储类型
Value	string	否	标签键的值，与 Tag Key 组成标签的键值对。	开发

返回参数

名称	类型	描述	示例值
	object	对象。
RequestId	string	请求 ID。	1E83311F-0EE4-4922-A3BF-730B312B****
PageNumber	integer	实例列表的页码。	1
PageSize	integer	输入时设置的每页行数。	30
TotalCount	integer	实例总个数。	1
Instances	array<object>	由 Instance 组成的集合。
KVStoreInstance	object	对象。
VpcId	string	专有网络（VPC）的 ID。	vpc-bp1nme44gek34slfc****
PrivateIp	string	专有网络 IP 地址。说明实例的网络类型为经典网络时，不会返回本参数。	172.16.49.***
Capacity	long	实例容量，单位：MB。	4096
ReplacateId	string	多活实例的逻辑 ID。	grr-bp11381ebc16****
CreateTime	string	实例的创建时间。	2018-11-07T08:49:00Z
ConnectionDomain	string	实例的内网连接地址。	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
IsRds	boolean	是否属 RDS 管控，返回值： true：是。 false：否。	true
ChargeType	string	付费类型，返回值： PrePaid：预付费。 PostPaid：后付费。	PostPaid
ArchitectureType	string	架构类型，返回值： cluster：集群版。 standard：标准版。 rwsplit：读写分离版。 NULL：所有类型，默认值。	cluster
NetworkType	string	网络类型，返回值： CLASSIC：经典网络。 VPC：专有网络。	CLASSIC
ConnectionMode	string	实例的访问模式，返回值： Standard：标准访问模式。 Safe：数据库代理模式。	Standard
Port	long	Redis 服务端口。	6379
SecondaryZoneId	string	备可用区 ID。说明若 ZoneId 参数已返回多可用区，例如"cn-hangzhou-MAZ10(h,i)"，本参数将不返回备可用区 ID。	cn-hangzhou-h
EngineVersion	string	Redis 实例的引擎版本，返回值：2.8、4.0、5.0或6.0。	4.0
PackageType	string	套餐类型，返回值： standard：标准套餐。 customized：定制套餐。	standard
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\"}
Bandwidth	long	实例带宽，单位：MB/s。	96
InstanceName	string	实例的名称。	apitest
ShardCount	integer	集群的数据节点数。说明云原生版集群或读写分离架构实例才会返回本参数。	3
UserName	string	连接使用的用户名，默认包含有一个以实例 ID 命名的用户名。	r-bp1zxszhcgatnx****
GlobalInstanceId	string	分布式实例 ID。说明当实例为分布式实例中的子实例时，才会返回该参数。	gr-bp14rkqrhac****
QPS	long	每秒请求数（Queries per Second）。	100000
InstanceClass	string	实例的规格。	redis.logic.sharding.2g.2db.0rodb.4proxy.default
DestroyTime	string	销毁实例的时间。	2019-04-28T10:03:01Z
InstanceId	string	实例的 ID。	r-bp1zxszhcgatnx****
InstanceType	string	实例类型，返回值： Tair。 Redis。 Memcache。	Redis
HasRenewChangeOrder	boolean	是否有未生效的续费变配订单，返回值： true：是。 false：否。	false
RegionId	string	地域 ID。	cn-hangzhou
EndTime	string	包年包月实例到期时间。	2019-06-13T16:00:00Z
VSwitchId	string	虚拟交换机的 ID。	vsw-bp1e7clcw529l773d****
NodeType	string	节点类型，返回值： double：双副本。 single：单副本（已下线）。	double
Connections	long	实例的连接数限制。	20000
ResourceGroupId	string	实例所属的资源组 ID。	rg-acfmyiu4ekp****
ZoneId	string	可用区 ID。	cn-hangzhou-b
InstanceStatus	string	实例状态，返回值： Normal：正常。 Creating：创建中。 Changing：修改中。 Inactive：被禁用。 Flushing：清除中。 Released：已释放。 Transforming：转换中。 Unavailable：服务停止。 Error：创建失败。 Migrating：迁移中。 BackupRecovering：备份恢复中。 MinorVersionUpgrading：小版本升级中。 NetworkModifying：网络变更中。 SSLModifying：SSL 变更中。 MajorVersionUpgrading：大版本升级中，可正常访问。	Normal
ComputingType	string	实例计算类型，返回值: Ecs: 云原生 Machine: 物理机	Ecs
CloudType	string	仅云盒实例显示该参数。	cloudbox
EditionType	string	实例类型，取值： Community：社区版。 Enterprise：企业版。	Enterprise
Tags	array<object>	标签信息。
Tag	object	对象。
Key	string	Tag 的 Key。	key1
Value	string	Tag 的 Value。	value1
ShardClass	string	数据分片节点规格，规格详情请参见规格查询导航。说明集群架构实例的整体性能为：分片节点规格（ShardClass） * 分片数（ShardCount）。	redis.shard.small.ce

示例

正常返回示例

JSON格式

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Instances": {
    "KVStoreInstance": [
      {
        "VpcId": "vpc-bp1nme44gek34slfc****",
        "PrivateIp": "172.16.49.***",
        "Capacity": 4096,
        "ReplacateId": "grr-bp11381ebc16****",
        "CreateTime": "2018-11-07T08:49:00Z",
        "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
        "IsRds": true,
        "ChargeType": "PostPaid",
        "ArchitectureType": "cluster",
        "NetworkType": "CLASSIC",
        "ConnectionMode": "Standard",
        "Port": 6379,
        "SecondaryZoneId": "cn-hangzhou-h",
        "EngineVersion": "4.0",
        "PackageType": "standard",
        "Config": "{\\\"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\\\"}",
        "Bandwidth": 96,
        "InstanceName": "apitest",
        "ShardCount": 3,
        "UserName": "r-bp1zxszhcgatnx****",
        "GlobalInstanceId": "gr-bp14rkqrhac****",
        "QPS": 100000,
        "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
        "DestroyTime": "2019-04-28T10:03:01Z",
        "InstanceId": "r-bp1zxszhcgatnx****",
        "InstanceType": "Redis",
        "HasRenewChangeOrder": false,
        "RegionId": "cn-hangzhou",
        "EndTime": "2019-06-13T16:00:00Z",
        "VSwitchId": "vsw-bp1e7clcw529l773d****",
        "NodeType": "double",
        "Connections": 20000,
        "ResourceGroupId": "rg-acfmyiu4ekp****",
        "ZoneId": "cn-hangzhou-b",
        "InstanceStatus": "Normal",
        "ComputingType": "Ecs",
        "CloudType": "cloudbox",
        "EditionType": "Enterprise",
        "Tags": {
          "Tag": [
            {
              "Key": "key1",
              "Value": "value1"
            }
          ]
        },
        "ShardClass": "redis.shard.small.ce",
        "ReplicaCount": 0,
        "SlaveReplicaCount": 0,
        "ReadOnlyCount": "",
        "SlaveReadOnlyCount": 0
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

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

变更历史

变更时间	变更内容概要	操作
2024-10-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-19	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-13	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-03-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-03-07	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情