DescribeImageList - Cloud Phone - Alibaba Cloud Documentation Center

Queries images.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The ID of the image.	imgc-075cllfeuazh0****
ImageType	string	Yes	The type of the image. Valid values: User: custom images. System: system images.	System
ImageName	string	No	The name of the image.	Android 12 image
Status	string	No	The state of the image. Valid values: AVAILABLE: The image is available. DELETE: The image is deleted. INIT: The image is being initialized. CREATE_FAILED: The image failed to be created. CREATING: The image is being created.	AVAILABLE
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the parameter is left empty, the data is queried from the first entry.	AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****
MaxResults	integer	No	The maximum number of entries per page. Value range: 1 to 100. Default value: 20.	20
ImagePackageType	string	No	Image package type.	VM

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
Data	array<object>	The objects that are returned.
Data	object	The object that is returned.
AliUid	long	The ID of the Alibaba Cloud account.	117819727354****
Description	string	The description of the image.	description
GmtCreate	string	The time when the image was created.	2024-02-01 10:56:36
GmtModified	string	The time when the image was last modified.	2024-02-01 10:56:36
ImageId	string	The ID of the image.	imgc-075cllfeuazh****
ImageType	string	The type of the image. Valid values: User: custom images. System: system images.	System
Language	string	The language of the image.	zh
ImageName	string	The name of the image.	IMAGE
ImageRegionList	array	The list of regions.
ImageRegionList	string	The region.	cn-hangzhou
Status	string	The state of the image. Valid values: AVAILABLE: The image is available. DELETE: The image is deleted. INIT: The image is being initialized. CREATE_FAILED: The image failed to be created. CREATING: The image is being created.	AVAILABLE
SystemType	string	The OS type of the image.	Android 12
ImageRegionDistributeMap	object	The region where the image is distributed. The key is the region and the value is the distribution information.
	object	The information about the image distribution task.
DistributeStatus	string	The status of the image distribution task. Valid values: AVAILABLE: The task is ready. DELETE: The task is deleted. INIT: The task is being initialized. CREATE_FAILED: The task failed to be created. CREATING: The task is being created.	AVAILABLE
Progress	string	The distribution progress of the image.	100%
ReleaseTime	string	The time when the image was published.	2024-07-25 10:06:45
RenderingType	string	The rendering type. Valid values: GPURemote CPU GPULocal	CPU
TotalCount	integer	The total number of entries returned.	30
RequestId	string	The ID of the request.	620740FF-492F-5956-B1BA-361E966C0269

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
  "Data": [
    {
      "AliUid": 0,
      "Description": "description",
      "GmtCreate": "2024-02-01 10:56:36\n",
      "GmtModified": "2024-02-01 10:56:36\n",
      "ImageId": "imgc-075cllfeuazh****",
      "ImageType": "System",
      "Language": "zh",
      "ImageName": "IMAGE",
      "ImageRegionList": [
        "cn-hangzhou"
      ],
      "Status": "AVAILABLE",
      "SystemType": "Android 12",
      "ImageRegionDistributeMap": {
        "key": {
          "DistributeStatus": "AVAILABLE",
          "Progress": "100%"
        }
      },
      "ReleaseTime": "2024-07-25 10:06:45",
      "RenderingType": "CPU"
    }
  ],
  "TotalCount": 30,
  "RequestId": "620740FF-492F-5956-B1BA-361E966C0269"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-24	The response structure of the API has changed	View Change Details