調用該接口查詢實例列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cr:ListInstance | get | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceName | string | 否 | 實例名稱。 | test |
| InstanceStatus | string | 否 | 實例狀態，取值：
| RUNNING |
| PageNo | integer | 否 | 頁號。 | 1 |
| PageSize | integer | 否 | 頁大小。 | 30 |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmv36i4is**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "A2A9BA68-B264-4953-9154-CE61B1C03BA6",
"Code": "success",
"PageNo": 1,
"IsSuccess": true,
"PageSize": 30,
"TotalCount": 12121,
"Instances": [
{
"ModifiedTime": "1562849760000",
"InstanceName": "test",
"CreateTime": "1562849679000",
"InstanceSpecification": "Enterprise_Basic",
"InstanceStatus": "RUNNING",
"InstanceId": "cri-sgedpenzw80e****",
"RegionId": "cn-shanghai",
"ResourceGroupId": "rg-aek2h3aexpy****",
"InstanceIssue": "oss bucket already exists",
"Tags": [
{
"TagKey": "",
"TagValue": ""
}
]
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 |
|---|---|---|
| 403 | NoPrivilege | Access denied for this user. |
| 500 | SystemError | Unknown error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-06-30 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |