调用该接口查询实例列表。
调试
您可以在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 返回结构发生变更 | 查看变更详情 |