DescribeImages

1. API Description

This API is used to query the details of images.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
imageIds	No	Array of String	ID list of images. Call DescribeImages and find imageId in the response.
imageName	No	String	Image name.
zoneId	Yes	String	Availability zone ID. Call DescribeZones and find zoneId in the response.
category	No	String	Image category. Available values: CentOS Windows Ubuntu Debian Rocky Fedora FreeBSD Alpine ArchLinux AlmaLinux openSUSE Gentoo Generic OTHERS
imageType	No	String	Image type. Available values: PUBLIC_IMAGE: public image. CUSTOM_IMAGE: custom image.
osType	No	String	Operating system type. Available values: windows linux bsd android any
imageStatus	No	String	Image status. CREATING: creating. AVAILABLE: able to use. UNAVAILABLE: unable to use.
pageNum	No	Integer	Number of pages returned. Default value: 1.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
totalCount	Integer	Number of images meeting the filtering conditions.
dataSet	Array of ImageInfo	Information on an image.

4. Code Example

Example

Query images with linux images installed in availability zone of asia-east-1a. 3 items per page, default to page 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",
        "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",
        "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",
        "category": "Ubuntu",
        "osType": "linux"
      }
    ],
    "totalCount": 16
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_ZONE_NOT_FOUND	Availability zone does not exist.