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.
imageName
No
String
Image name.
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
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.
4. Code Example
Query all available images with no parameter.
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.
404
INVALID_ZONE_NOT_FOUND
Zone not found.
Last updated