DescribeImageList - Cloud Phone - Alibaba Cloud Documentation Center

Queries a list of available images.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The image ID.	imgc-075cllfeuazh0****
ImageType	string	Yes	The image type. Valid values: User : custom image System : OS image	System
ImageName	string	No	The image name.	安卓12系统镜像
Status	string	No	The status 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 token that specifies the position from which to start the query. If you leave this parameter empty, the query starts from the beginning.	AAAAAV3MpHK1AP0pfERHZN5pu6kw9dGL5jves2FS9RLq****
MaxResults	integer	No	The maximum number of entries to return on each page for a paged query. Valid values: 1 to 100. Default value: 20.	20
ImagePackageType	string	No	Note This parameter is not yet available.	null
InstanceType	string	No	The instance type.	cpm.gx7.10xlarge
ImageBizTags	array<object>	No	An array of tag objects.
	object	No	The tag object.
Key	string	No	The tag key.	key1
Value	string	No	The tag value.	value1
SystemType	string	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used to start the next query. An empty value indicates that all data has been returned.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
Data	array<object>	The returned data.
	array<object>	The returned data.
AliUid	integer	The ID of the Alibaba Cloud account.	117819727354****
Description	string	The description.	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 image ID.	imgc-075cllfeuazh****
ImageType	string	The image type. Valid values: User : custom image System : OS image	System
Language	string	The language.	zh
ImageName	string	The image name.	IMAGE
ImageRegionList	array	The list of available regions.
	string	The region.	cn-hangzhou
Status	string	The image status. 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 operating system type.	Android 12
ImageRegionDistributeMap	object	The image distribution information by region. The key is the region and the value is the distribution information.
	object	The distribution information.
DistributeStatus	string	The distribution status. 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
Progress	string	The distribution progress.	100%
ReleaseTime	string	The time when the image was published.	2024-07-25 10:06:45
RenderingType	string	The rendering type. Valid values: GPURemote : GPURemote CPU : CPU GPULocal : GPULocal	CPU
ImageVersion	string	The image version.	20241204102337
ImageBizTags	array<object>	An array of tag objects.
	object	The tag object.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
TotalCount	integer	The total number of entries.	30
RequestId	string	The request ID.	620740FF-492F-5956-B1BA-361E966C0269

Examples

Success response

JSON format

{
  "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",
      "ImageVersion": "20241204102337",
      "ImageBizTags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ]
    }
  ],
  "TotalCount": 30,
  "RequestId": "620740FF-492F-5956-B1BA-361E966C0269"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.