查詢一個或多個云數據庫 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 返回結構發生變更 | 查看變更詳情 |