DescribeImages¶
获取一个或多个映像
可根据映像ID，状态，映像名称、操作系统平台作过滤条件，来获取映像列表。 如果不指定任何过滤条件，默认返回你所拥有的所有映像。 如果指定不存在的映像ID，或非法状态值，则会返回错误信息。
Request Parameters
| Parameter name | Type | Description | Required |
|---|---|---|---|
| images.n | String | 映像ID | No |
| processor_type | String | 映像支持的处理器类型，有效值为 64bit 和 32bit | No |
| os_family | String | 映像操作系统发行版，有效值为 centos，ubuntu，debian，fedora 和 windows 等 | No |
| visibility | String | 映像的可见范围，有效值为 public 和 private | No |
| provider | String | 映像提供者。初始青云系统会提供一系列默认映像，其 provider 为 system 。 当用户捕获主机后，被捕获的“自有”映像的 provider 为 self 。 参见 CaptureInstance |
No |
| status.n | String | 映像状态: pending, available, deprecated, suspended, deleted, ceased | No |
| search_word | String | 搜索关键词，支持映像ID，映像名称 | No |
| verbose | Integer | 是否返回冗长的信息，目前 verbose 只支持为 0。 | No |
| offset | Integer | 数据偏移量，默认为0 | No |
| limit | Integer | 返回数据长度，默认为20，最大100 | No |
| zone | String | 区域 ID，注意要小写 | Yes |
Response Elements
| Name | Type | Description |
|---|---|---|
| action | String | 响应动作 |
| image_set | Array | JSON 格式的映像数据列表，每项参数可见下面 Response Item |
| total_count | Integer | 根据过滤条件得到的映像总数 |
| ret_code | Integer | 执行成功与否，0 表示成功，其他值则为错误代码 |
Response Item
| Name | Type | Description |
|---|---|---|
| image_id | String | 映像ID |
| image_name | String | 映像名称 |
| description | String | 映像描述 |
| size | Integer | 映像空间大小，单位为 GB |
| processor_type | String | 映像支持的处理器类型，有效值为 64位 ( 64bit ) 和 32位 ( 32bit ) |
| platform | String | 映像操作系统平台，有效值为 linux 和 windows |
| os_family | String | 映像操作系统发行版，有效值为 centos，ubuntu，debian，fedora 和 windows 等 |
| visibility | String | 映像的可见范围，有效值为 public 和 private public: 对所有人可见，例如系统提供的映像 private: 只对映像所有者可见，例如用户的自有映像 |
| provider | String | 映像提供者，有效值为 system 和 self system: 映像提供者为青云系统 self: 映像提供者为用户自己 |
| owner | String | 映像提供者ID |
| recommended_type | String | 运行该映像的推荐主机配置 |
| status | String | 映像状态，有效值为pending, available, deprecated, suspended, deleted, ceased。 pending： 等待被创建 available： 可用状态，此时可以基于该映像创建主机。 deprecated： 已被弃用，此时不再可以基于该映像创建新的主机，但不影响已有主机的正常使用。 suspended： 由于欠费，已被暂停使用 deleted： 已被删除，但处于此状态的映像在2小时之内仍可以被恢复为 available 状态 ceased： 已被彻底删除，处于此状态的映像无法恢复 |
| transition_status | String | 映像过渡状态，有效值为creating, suspending，resuming，deleting，recovering。 creating： 创建中，由 pending 状态变成 available 状态 suspending： 欠费暂停中，由 available 状态变成 suspended 状态 resuming： 恢复中，由 suspended 状态变成 available 状态 deleting： 删除中，由 available/suspended 状态变成 deleted 状态 recovering： 恢复中，由 deleted 状态变成 available 状态 |
| create_time | TimeStamp | 映像创建时间，为UTC时间，格式可参见 ISO8601. |
| status_time | TimeStamp | 映像最近一次状态变更时间，为UTC时间，格式可参见 ISO8601. |
Example
Example Request:
https://api.qingcloud.com/iaas/?action=DescribeImages
&COMMON_PARAMS
Example Response:
{
"action":"DescribeImagesResponse",
"total_count":9,
"image_set":[
{
"status":"ceased",
"processor_type":"64bit",
"image_id":"img-37amqany",
"sub_code":1,
"transition_status":"",
"recommended_type":"small_b",
"image_name":"",
"visibility":"private",
"platform":"linux",
"create_time":"2013-08-07T18:16:32Z",
"os_family":"centos",
"provider":"self",
"owner":"usr-1234abcd",
"status_time":"2013-08-17T08:16:33Z",
"size":20,
"description":null
}
],
"ret_code":0
}