查询指定地域下一个或多个已创建的自定义镜像信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| swas-open:ListCustomImages |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。 | cn-hangzhou |
| ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。 | 123e4567-e89b-12d3-a456-426655440000 |
| ImageIds | string | 否 | 轻量应用服务器的镜像 ID。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。 | ["fe9c66133a9d4688872869726b52****", "794c230fd3e64ea19f83f4d7a0ad****"] |
| PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
| PageNumber | integer | 否 | 快照列表的页码。 默认值：1。 | 1 |
| ImageNames | string | 否 | 轻量应用服务器的镜像名称。取值可以由多个实例 ID 组成一个 JSON 数组，最多支持 100 个 ID，ID 之间用半角逗号（,）隔开。 | ["test1****", "test2****"] |
| SystemSnapshotId | string | 否 | 系统盘快照 ID。 | s-bp14m09pq8***0g6 |
| DataSnapshotId | string | 否 | 数据盘快照 ID。 | s-acscasca**** |
| Tag | array<object> | 否 | 自定义镜像的标签列表。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 自定义镜像的标签键。标签键长度的取值范围：1~64。N 的取值范围：1~20。 | TestKey |
| Value | string | 否 | 自定义镜像的标签值。标签值长度的取值范围：1~64。N 的取值范围：1~20。 | TestValue |
| ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek2bti7cf7yj2i |
| Share | boolean | 否 | 是否查询共享镜像。取值范围：
不填则默认返回所有镜像。 | False |
| InstanceId | string | 否 | 镜像的来源轻量应用服务器实例 ID。 | ace0706b2ac4454d984295a94213**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
"CustomImages": [
{
"CreationTime": "2022-10-09T02:28:06Z",
"DataSnapshotName": "数据盘快照",
"SystemSnapshotId": "s-bp1h173hj21puxb***",
"InShare": false,
"InShareUser": true,
"InstanceId": "2d06ee0520b44de1ae88d4be****",
"DataSnapshotId": "s-bp19rn9u8eqzlfb***",
"RegionId": "cn-hangzhou",
"SystemSnapshotName": "系统盘快照",
"Description": "自定义镜像-1",
"Name": "test",
"ImageId": "m-bp1e79zktg26n2b***",
"Status": "1",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"InstanceName": "swas-asdf23***",
"ResourceGroupId": "rg-acfm2h2lvp3ublq",
"CreateInstances": [
"9ffb716db6ae406ca78a476c0c81****"
],
"UserId": 0,
"OsType": "Linux"
}
],
"TotalCount": "4",
"PageSize": "10",
"PageNumber": "1"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. | 内部错误，请重试。如果多次尝试失败，请提交工单。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-07-02 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-20 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |