查詢實(shí)例列表。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫(xiě)入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| selectdb:DescribeDBInstances | list | *全部資源 * |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-4690g37929**** |
| DBInstanceIds | string | 否 | 實(shí)例 ID，多個(gè)實(shí)例 ID 之間用英文逗號(hào)（,）分隔。 | selectdb-cn-7213cjv**** |
| DBInstanceStatus | string | 否 | 實(shí)例的狀態(tài)，取值說(shuō)明：
| ACTIVATION |
| DBInstanceDescription | string | 否 | 實(shí)例備注信息。 | 新建實(shí)例測(cè)試 |
| PageSize | long | 否 | 每頁(yè)記錄數(shù)，取值：
| 30 |
| PageNumber | long | 否 | 頁(yè)數(shù)。 | 1 |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
| Tag | array<object> | 否 | 實(shí)例標(biāo)簽列表信息。 | |
| object | 否 | 實(shí)例標(biāo)簽列表。 | ||
| Key | string | 否 | 標(biāo)簽鍵。 | testKey |
| Value | string | 否 | 標(biāo)簽值。 | testValue |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "BC854513-E85E-54F3-9842-B9CCD3308CDD",
"PageNumber": 30,
"PageSize": 1,
"TotalRecordCount": 2,
"Items": [
{
"connectionString": "暫不返回",
"DBInstanceId": "selectdb-cn-7213cjv****",
"Description": "新建實(shí)例測(cè)試",
"Engine": "selectdb",
"EngineVersion": "2.4",
"InstanceUsedType": "Instance",
"RegionId": "cn-hangzhou",
"ZoneId": "cn-hangzhou-i",
"ChargeType": "PrePaid",
"Category": "basic",
"Status": "ACTIVATION",
"VpcId": "vpc-bp175iuvg8nxqraf2****",
"VswitchId": "vsw-bp1gzt31twhlo0sa5****",
"ResourceCpu": 8,
"ResourceMemory": 64,
"ScaleMin": 0,
"ScaleMax": 0,
"ScaleReplica": 0,
"StorageSize": 100,
"StorageType": "cloud_essd",
"ObjectStoreSize": 200,
"ExpireTime": "2024-03-29T03:47:05Z",
"LockMode": 0,
"LockReason": "nolock",
"IsDeleted": false,
"MaintainStarttime": "保留參數(shù)，暫不返回",
"MaintainEndtime": "保留參數(shù)，暫不返回",
"GmtCreated": "2023-08-12T04:14Z\n",
"GmtModified": "2023-08-12T19:05Z",
"ParentInstance": "保留參數(shù)，暫不返回",
"ResourceGroupId": "保留參數(shù)，暫不返回",
"MaintainStartTimeStr": "保留參數(shù)，暫不返回",
"MaintainEndTimeStr": "保留參數(shù)，暫不返回",
"TenantClusterId": "保留參數(shù)，暫不返回\n",
"TenantToken": "保留參數(shù)，暫不返回\n",
"TenantUserId": "保留參數(shù)，暫不返回\n",
"Tags": [
{
"TagKey": "testKey",
"TagValue": "testValue"
}
],
"ClusterCount": 1
}
]
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | InvalidPageNumber.Malformed | The specified parameter "PageNumber" is not valid. | 每頁(yè)記錄數(shù)參數(shù)不合法。 |
| 400 | DocumentConvertFailed.ExceedFileSizeLimit | The conversion has been failed, exceed file size limit. | 文檔轉(zhuǎn)換失敗，文件大小超過(guò)系統(tǒng)限額。 |
| 400 | Forbidden | User not authorized to operate on the specified resource, or this API does not support RAM. | 子賬號(hào)權(quán)限不足，請(qǐng)先獲取授權(quán)。 |
| 400 | InvalidDBName | The specified database name is not allowed. | 數(shù)據(jù)庫(kù)名稱不符合要求，請(qǐng)確認(rèn)數(shù)據(jù)名稱是否正確。 |
| 400 | CreateOrderFailed | Failed to create order. | 創(chuàng)建訂單失敗。 |
| 403 | DBClusterNotSupported | The requested operation can not be performed while the cluster is not sale. | 當(dāng)集群未運(yùn)行時(shí)，無(wú)法執(zhí)行請(qǐng)求的操作。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 當(dāng)前實(shí)例狀態(tài)不支持此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | 操作失敗，實(shí)例引擎和類型不支持該操作。 |
| 403 | InvalidDBInstanceState.NotSupport | The specified instance state does't support this operation. | 指定的實(shí)例狀態(tài)不支持此操作。 |
| 403 | MoneyLessThan100 | The Account Monet less Than 100. | 當(dāng)前阿里云賬號(hào)余額不足100，請(qǐng)充值。 |
| 403 | OperationDenied.DBNameAndAccountPrivilegeCount | The operation is not permitted due to count of database or account privilege. | 操作失敗，數(shù)據(jù)庫(kù)與權(quán)限的數(shù)量不一致。 |
| 403 | InsufficientResourceCapacity | The resource is out of usage. | 資源不足，請(qǐng)您稍后再試。 |
| 404 | DBInstanceLocked | The current instance lock mode does not support this operation. | 操作失敗，當(dāng)前實(shí)例已鎖定。 |
| 404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交換機(jī)參數(shù)無(wú)效。 |
| 404 | InvalidApi.NotFound | Specified api is not found, please check your url and method. | 找不到指定的 API。請(qǐng)檢查調(diào)用的 URL 和方法。您調(diào)用的 API 不存在。請(qǐng)檢查 API 的名稱是否正確，請(qǐng)注意確認(rèn)大小寫(xiě)。 |
| 404 | InvalidDBInstance.NotFound | The specified instance is not found. | 沒(méi)有找到指定的實(shí)例，請(qǐng)檢查實(shí)例的正確性。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified instance classic does not exist. | 當(dāng)前選擇的配置或規(guī)格不存在或已停售，請(qǐng)重新選擇。 |
| 404 | InvalidRegionId.NotFound | The provided RegionId does not exist in our records. | 操作失敗，輸入的地域及可用區(qū)不存在。 |
| 404 | QueryPrice.Failed | The inquiry failed. Contact Alibaba Cloud customer service representatives. | 詢價(jià)失敗，請(qǐng)聯(lián)系客服同學(xué)。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-06-24 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-06-12 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-12-27 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |