DescribeImages

1. 接口描述

调用本接口用于查看镜像列表。

注意事项

• 镜像列表中的镜像并不是适用于所有机型，具体机型适用的镜像可以根据DescribeInstanceTypes接口返回结构中的imageIds来查询。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
imageIds	否	Array of String	镜像ID。
imageName	否	String	镜像名称。
catalog	否	String	镜像所属分类。 可能值： centos windows ubuntu debian esxi
imageType	否	String	镜像类型。 PUBLIC_IMAGE: 公共镜像。 CUSTOM_IMAGE：自定义镜像。 目前不支持自主的创建自定义镜像，如有需求，请提交support。
osType	否	String	操作系统类型。 可能值： windows linux
instanceTypeId	否	String	支持的机型ID。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。
images	Array of ImageInfo	结果集。

4. 代码示例

示例

1. 获取所有的镜像。

不带任何参数查询所有的镜像。

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeImages
<Common Request Params>

Response:
{
  "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
  "response": {
    "requestId": "T4C35327C-7B13-47B8-A815-5E5213D4A9F9",
    "images": [
      {
        "imageId": "bd5faa16-39d2-4bbf-a5c8-b95a193b1626",
        "imageName": "CentOS7.4-x86_64",
        "catalog": "centos",
        "imageType": "PUBLIC_IMAGE",
        "osType": "linux"
      }
    ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_INSTANCE_TYPE_NOT_FOUND	指定的机型不存在。