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

Zone ID. Call DescribeZones and find zoneId in the response.

category

No

String

Image category.

Available values:

  • CentOS

  • Windows

  • Ubuntu

  • Debian

imageType

No

String

Image type.

  • PUBLIC_IMAGE: the default images.

  • CUSTOM_IMAGE: the newly created images by yourself.

osType

No

String

Operating system type.

Available values:

  • Windows

  • Linux

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

Query all available images with no parameter.

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

Request:
{
  "zoneId": "FRA-A",
  "osType": "linux",
  "pageSize": 3
}

Response:
{
  "requestId": "T6818FFFC-B917-4E46-8BEC-D8BBD8FA2AA5",
  "response": {
    "requestId": "T6818FFFC-B917-4E46-8BEC-D8BBD8FA2AA5",
    "dataSet": [
      {
        "imageVersion": "18.04",
        "imageId": "img-EVhEsCuXhCN0urZ7Vt77oOr6K",
        "imageName": "Ubuntu Server 18.04 LTS x86 64-bit",
        "imageDescription": null,
        "osType": "linux",
        "imageSize": "30",
        "imageStatus": "AVAILABLE",
        "category": "Ubuntu",
        "imageType": "PUBLIC_IMAGE"
      },
      {
        "imageVersion": "11.5",
        "imageId": "img-MJHkbWzEl9anNobblDtpRTDPB",
        "imageName": "Debian 11.5 Amd x86 64-bit",
        "imageDescription": null,
        "osType": "linux",
        "imageSize": "30",
        "imageStatus": "AVAILABLE",
        "category": "Debian",
        "imageType": "PUBLIC_IMAGE"
      },
      {
        "imageVersion": "7.4",
        "imageId": "img-3ELi56cECstEUqmcQzqIGdiuB",
        "imageName": "CentOS 7.4.1708 x86 64-bit",
        "imageDescription": null,
        "osType": "linux",
        "imageSize": "30",
        "imageStatus": "AVAILABLE",
        "category": "CentOS",
        "imageType": "PUBLIC_IMAGE"
      }
    ],
    "totalCount": 7
  }
}

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

Zone not found.

Last updated