查询一个或多个云数据库 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 |
| ChargeType | string | 否 | 付费类型，取值：
| PostPaid |
| NetworkType | string | 否 | 网络类型，取值：
| 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 | 否 | 实例类型，取值：
| Redis |
| SearchKey | string | 否 | 支持模糊搜索实例名称或实例 ID。 | apitest |
| ArchitectureType | string | 否 | 架构类型，取值：
| standard |
| Expired | string | 否 | 实例的过期状态，取值：
| false |
| ZoneId | string | 否 | 可用区 ID。 | cn-hongkong-b |
| ResourceGroupId | string | 否 | 资源组 ID。 说明
您可以通过调用 ListResourceGroups 接口或通过控制台获取资源组 ID 列表。相关操作，请参见查看资源组基本信息。
| rg-acfmyiu4ekp**** |
| GlobalInstance | boolean | 否 | 返回的实例列表中，是否过滤分布式实例中的子实例，取值：
| true |
| EditionType | string | 否 | 实例类型，取值：
| Enterprise |
| PrivateIp | string | 否 | 专有网络 IP 地址。 | 172.16.49.*** |
| Tag | array<object> | 否 | 实例的标签信息。 | |
| object | 否 | 对象。 | ||
| Key | string | 否 | 标签的键，与 Tag Value 组成标签的键值对。 说明
单次最多支持传入 5 组标签的键值对。
| 存储类型 |
| Value | string | 否 | 标签键的值，与 Tag Key 组成标签的键值对。 | 开发 |
返回参数
示例
正常返回示例
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 返回结构发生变更 | 查看变更详情 |