DescribeImages

1. 接口描述

本接口（DescribeImages）用于查看镜像列表。

2. 请求参数

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

参数名称	必选	类型	描述
imageIds	否	Array of String	镜像ID。 可从DescribeImages 返回的imageId获取。
imageName	否	String	镜像名称。
zoneId	是	String	可用区ID。 可从DescribeZones的zoneId中获取。
category	否	String	镜像所属分类。 可能值： CentOS Windows Ubuntu Debian Rocky Fedora FreeBSD Alpine ArchLinux AlmaLinux openSUSE Gentoo Generic OTHERS
imageType	否	String	镜像类型。 PUBLIC_IMAGE-公共镜像。 CUSTOM_IMAGE-自定义镜像。
osType	否	String	操作系统类型。 可能值： windows linux bsd android any
imageStatus	否	String	镜像状态。 CREATING-创建中 AVAILABLE-可用 UNAVAILABLE-不可用
pageNum	否	Integer	返回的分页数。 默认为1。
pageSize	否	Integer	返回的分页大小。 默认为20，最大为1000。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of ImageInfo	结果集。

4. 代码示例

示例

1. 查询asia-east-1a区域下，操作系统类型为linux的镜像，每页3条数据，默认查第1页。

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

Request:
{
  "zoneId": "asia-east-1a",
  "osType": "linux",
  "pageSize": 3
}

Response:
{
  "requestId": "TD67947F8-9B29-451F-9965-58AEDB4E5B7C",
  "response": {
    "requestId": "TD67947F8-9B29-451F-9965-58AEDB4E5B7C",
    "dataSet": [
      {
        "imageId": "ubuntu2404_20240712",
        "imageName": "Ubuntu Server 24.04 LTS",
        "imageType": "PUBLIC_IMAGE",
        "imageSize": "20",
        "imageDescription": null,
        "imageVersion": "Server 24.04 LTS",
        "imageStatus": "AVAILABLE",
        "nicNetworkType": ["FailOver","VirtioOnly"],
        "category": "Ubuntu",
        "osType": "linux"
      },
      {
        "imageId": "ubuntu2204_20240712",
        "imageName": "Ubuntu Server 22.04 LTS",
        "imageType": "PUBLIC_IMAGE",
        "imageSize": "20",
        "imageDescription": null,
        "imageVersion": "Server 22.04 LTS",
        "imageStatus": "AVAILABLE",
        "nicNetworkType": ["FailOver","VirtioOnly"],
        "category": "Ubuntu",
        "osType": "linux"
      },
      {
        "imageId": "ubuntu2004_20240712",
        "imageName": "Ubuntu Server 20.04 LTS",
        "imageType": "PUBLIC_IMAGE",
        "imageSize": "20",
        "imageDescription": null,
        "imageVersion": "Server 20.04 LTS",
        "imageStatus": "AVAILABLE",
        "nicNetworkType": ["FailOver","VirtioOnly"],
        "category": "Ubuntu",
        "osType": "linux"
      }
    ],
    "totalCount": 16
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明
404	INVALID_ZONE_NOT_FOUND	没有找到指定的区域。