查詢一個或多個云數據庫 Tair(兼容 Redis)實例的信息概覽。
接口說明
若您未指定請求參數,將返回所有實例的信息概覽。
說明
該接口返回結果均無分頁。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
kvstore:DescribeInstancesOverview | get | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 實例所屬的地域 ID,可調用 DescribeRegions 接口獲取。 | cn-hangzhou |
InstanceIds | string | 否 | 需要查詢的實例 ID。 說明
默認查詢該賬號下所有實例。如需傳入多個實例 ID 時,使用英文逗號(,)分隔實例 ID。
| r-bp1zxszhcgatnx**** |
InstanceStatus | string | 否 | 實例狀態,取值:
說明
更多實例狀態及詳細信息,請參見實例狀態與影響。
| Normal |
ChargeType | string | 否 | 付費類型,取值:
| PostPaid |
NetworkType | string | 否 | 網絡類型,取值:
| CLASSIC |
EngineVersion | string | 否 | 實例兼容 Redis 的版本,返回值:2.8、4.0、5.0、6.0或7.0。 | 6.0 |
InstanceClass | string | 否 | 實例規格,請參見實例規格表。 | redis.master.small.default |
VpcId | string | 否 | 專有網絡 ID。 | vpc-bp1nme44gek34slfc**** |
VSwitchId | string | 否 | 虛擬交換機 ID。 | vsw-bp1e7clcw529l773d**** |
InstanceType | string | 否 | 實例類型,取值:
| Redis |
SearchKey | string | 否 | 基于實例 ID 或者實例備注模糊搜索時使用的關鍵字。 | apitest |
ArchitectureType | string | 否 | 架構類型,取值:
| standard |
ZoneId | string | 否 | 可用區 ID。 | cn-hangzhou-b |
ResourceGroupId | string | 否 | 資源組 ID。 說明
您可以通過調用 ListResourceGroups 接口或通過控制臺獲取資源組 ID 列表。相關操作,請參見查看資源組基本信息。
| rg-acfmyiu4ekp**** |
EditionType | string | 否 | 實例類型,取值:
| Enterprise |
PrivateIp | string | 否 | 專有網絡 IP 地址。 | 172.16.49.*** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
"TotalCount": 1,
"Instances": [
{
"VpcId": "vpc-bp1nme44gek34slfc****",
"PrivateIp": "172.16.49.***",
"Capacity": 4096,
"CreateTime": "2018-11-07T08:49:00Z",
"ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"ChargeType": "PrePaid",
"ArchitectureType": "cluster",
"NetworkType": "CLASSIC",
"EngineVersion": "6.0",
"InstanceName": "apitest",
"GlobalInstanceId": "gr-bp14rkqrhac****",
"InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
"InstanceId": "r-bp1zxszhcgatnx****",
"InstanceType": "Redis",
"RegionId": "cn-hangzhou",
"EndTime": "2022-06-13T16:00:00Z",
"VSwitchId": "vsw-bp1e7clcw529l773d****",
"ResourceGroupId": "rg-acfmyiu4ekp****",
"ZoneId": "cn-hangzhou-b",
"InstanceStatus": "Normal",
"SecondaryZoneId": "cn-hangzhou-g"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | InvalidInstanceIds.Malformed | The Specified parameter InstanceIds is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-06-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-03-06 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2021-11-23 | 新增 OpenAPI | 查看變更詳情 |