ListImage - App Streaming - Alibaba Cloud Documentation Center

Queries the image information about an ECS instance.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
appstreaming:ListImage	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ImageId	string	No	The image ID.	img-bp13mu****
ImageName	string	No	The image name. Fuzzy match is supported.	DemoImage
Status	string	No	The status of the image. You can query images in the specified status. By default, all images in the Not Deleted state are queried. Valid values: AVAILABLE: The image is available. INIT: The image is being initialized. CREATE_FAILED: The image failed to be created. CREATING: The image is being created.	INIT
ImageType	string	No	The type of the images. Valid values: User: a custom image. Shared: a shared image. System: a system image. Community: a community image.	User
PackageType	string	No	The image encapsulation type. Valid values: Ecs_Container: ECS and Docker image Ecs: ECS image	Ecs
OsType	string	No	The OS type of the image. Valid values: Linux Unknown Windows Android	Windows
BizType	integer	No	The service type. This parameter is not available publicly. Valid value: 1 (default)	1
ProductType	string	No	The product type. Valid values: CloudDesktop: Elastic Desktop Service CloudApp: App Streaming WuyingServer: Workstation	CloudApp
ProtocolType	string	No	The protocol type of the image. Valid values: HDX: the High-definition Experience (HDX) protocol ASP: the Alibaba Cloud-developed ASP protocol	ASP
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The current page number.	1
ProductTypeList	array	No	The list of products that are supported when the image supports multiple products.
	string	No	The product type. Valid values: CloudDesktop: Elastic Desktop Service CloudApp: App Streaming WuyingServer: Workstation	CloudApp
BizTypeList	array	No	The list of all service types. It is not available publicly.
	integer	No	The service type. Specify this parameter based on the service you actually use. Valid value: 1 (default)	1
FeatureList	array	No	The features supported by the image.
	string	No	The feature supported by the image. Valid values: FotaChannel: supports FOTA channels. Builder: supports image builder. MultiSession: supports multiple sessions. GPU: supports GPU.	GPU
LanguageType	string	No	The language. Valid values: en-US: English. zh-HK: Chinese, Traditional (Hong Kong, China). zh-CN: Simplified Chinese. ja-JP: Japanese.	zh-CN
ResourceInstanceType	string	No	Find images with certain fixed specifications.	eds.enterprise_office.2c4g
FotaVersion	string	No	The image version.	2.0.3-xxxx
PlatformName	string	No	The name of the operating system platform. Valid values: Ubuntu Debian Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows 11 Windows 10	Windows Server 2019
BizRegionIdList	array	No	The regions that are supported. The EDS images are centralized. Use this parameter to query the regions where the image is deployed.
	string	No	The region ID.	cn-shanghai
TagList	array<object>	No	The tags to query.
	object	No
Key	string	No	The key of the custom tag.	env
Value	string	No	The value of the custom tag.	test
PlatformNameList	array	No	The list of supported platform types. For valid values, refer to PlatformName above.
	string	No	The name of the image platform.	Windows 11

Response parameters

Parameter	Type	Description	Example
	object	The information about the image.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number returned.	1
Data	array<object>	The returned data.
ImageBaseInfoModel	object	The returned data.
GmtCreate	string	The creation time.	2025-04-25 15:13:57
GmtModified	string	The update time.	2025-04-25 15:13:57
AliUid	long	The tenant ID.	123456789
ImageId	string	System image IDs follow a descriptive, human-readable format, while custom image IDs are automatically generated by the system.	imgc-xxxx
ImageName	string	The image name.	DemoImage
ImageType	string	The type of the image.	User
PackageType	string	The image encapsulation type.	ECS
Description	string	The description of the image.
OsType	string	The type of the image.	Windows
ProtocolType	string	The protocol type.	ASP
BizType	integer	The service type.	1
ProductType	string	The product type.	CloudApp
VersionId	string	The version of the image.	iv-xxx
OnlineVersionId	string	This image tag currently points to the specified sub-version of the parent image. (An image consists of multiple sub-versions.)	iv-xxxx
LatestVersionId	string	The latest sub-version of the image. (An image consists of multiple sub-versions.)	iv-xxx
Status	string	The state of the image.	INIT
ParentImageId	string	The ID of the parent image from which this image is derived. Note: This field is only applicable to custom images, as system images do not have a parent.	imgc-xxx
ParentImageVersion	string	The version of the parent image.	iv-xxx
BaseImageId	string	The base image ID.	imgc-xxx
BaseImageVersion	string	The version of the base image.	iv-xxx
FotaVersion	string	The FOTA version.	2.3.0-xxx
Language	string	The image language. When the packaging type is VHD or Container, the image inherits its properties from the ECS-type image within the same image bundle.	zh-CN
Platform	integer	The operating system platform of the image. Note When the packaging type is VHD or Container, the image inherits its properties from the ECS-type image within the same image bundle.	Windows
OnlineVersion	boolean	Indicates whether the current version is the active version.
SystemDiskSize	integer	The size of the system disk. Unit: GiB. Note The system disk must be at least as large as the image.	40
DataDiskSize	integer	The size of the data disk. Unit: GiB.	100
AppList	array<object>	The application configuration.
appList	object
AppId	string	The ID of the application.	ca-xxx
AppName	string	The name of the application.
FeatureList	array	The image feature tags.
featureList	string	The image feature tag.	Builder
ImageCreateMode	string	The image creation type. Valid values: BY_SNAPSHOT_ID: The image is created from the snapshot or contains only a system disk. BUILDER_MANUAL: The image is manually generated. INSTANCE_AUTO: The image is automatically generated based on an instance. BY_INSTANCE_ID: The image is created from an instance or contains both a system disk and data disks.	BUILDER_MANUAL
ImageRegionList	array	The region ID.
imageRegionList	string	The region.
Distro	string	The name of the release.
VersionName	string	The version number.	v0.1.0
ResourceInstanceCategory	string	The types of resources that are supported by the images.	["eds.cpu.category"]
PlatformName	string	The name of the operating system platform.	Windows Server 2022
SupportedLanguageList	array	The supported languages.
supportedLanguageList	string	The supported language.	zh-CN
VolumeEncryptionEnabled	boolean	Specifies whether to enable disk encryption.	true
VolumeEncryptionKey	string	The ID of the Key Management Service (KMS) key that is used to encrypt the disk.	a7b3c0c8-xxxx
SessionType	string	The type of the session. Valid values: SINGLE_SESSION MULTIPLE_SESSION	SINGLE_SESSION
ImageRegionDistributeList	array<object>	Layered supported regions information.
ImageRegionDistributeList	object
ImageId	string	System image IDs follow a descriptive, human-readable format, while custom image IDs are automatically generated by the system.	imgc-xxx
RegionId	string	The supported region.	cn-shanghai
Status	string	The status.	INIT
VersionId	string	The version of the image.	iv-xxx
Progress	string	The progress.	70%
FotaChannel	string	Note This parameter is not available for public use.
CompatibleMode	boolean	Specifies whether to use the compatibility mode.	true
DriverList	array	The information about each driver.
driverList	string	The drivers.	["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
Count	integer	The total number of entries.	22
Success	boolean	Indicates whether the request was successful. Valid values: true: The request is successful. false: The request failed.	true
Code	string	The HTTP status code that is returned.	200
Message	string	The message that is returned for the request.	success
RequestId	string	The request ID.	8737D130-BFD0-5D51-96F6-C08EB1139A25

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "GmtCreate": "2025-04-25 15:13:57",
      "GmtModified": "2025-04-25 15:13:57",
      "AliUid": 123456789,
      "ImageId": "imgc-xxxx",
      "ImageName": "DemoImage",
      "ImageType": "User",
      "PackageType": "ECS",
      "Description": "",
      "OsType": "Windows",
      "ProtocolType": "ASP",
      "BizType": 1,
      "ProductType": "CloudApp",
      "VersionId": "iv-xxx",
      "OnlineVersionId": "iv-xxxx",
      "LatestVersionId": "iv-xxx",
      "Status": "INIT",
      "ParentImageId": "imgc-xxx",
      "ParentImageVersion": "iv-xxx",
      "BaseImageId": "imgc-xxx",
      "BaseImageVersion": "iv-xxx",
      "FotaVersion": "2.3.0-xxx",
      "Language": "zh-CN",
      "Platform": 0,
      "OnlineVersion": true,
      "SystemDiskSize": 40,
      "DataDiskSize": 100,
      "AppList": [
        {
          "AppId": "ca-xxx",
          "AppName": ""
        }
      ],
      "FeatureList": [
        "Builder"
      ],
      "ImageCreateMode": "BUILDER_MANUAL",
      "ImageRegionList": [
        ""
      ],
      "Distro": "",
      "VersionName": "v0.1.0",
      "ResourceInstanceCategory": [
        "eds.cpu.category"
      ],
      "PlatformName": "Windows Server 2022",
      "SupportedLanguageList": [
        "zh-CN"
      ],
      "VolumeEncryptionEnabled": true,
      "VolumeEncryptionKey": "a7b3c0c8-xxxx",
      "SessionType": "SINGLE_SESSION",
      "ImageRegionDistributeList": [
        {
          "ImageId": "imgc-xxx",
          "RegionId": "cn-shanghai",
          "Status": "INIT",
          "VersionId": "iv-xxx",
          "Progress": "70%"
        }
      ],
      "FotaChannel": "",
      "CompatibleMode": true,
      "DriverList": [
        [
          "00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        ]
      ]
    }
  ],
  "Count": 22,
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "8737D130-BFD0-5D51-96F6-C08EB1139A25"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InternalError	Internal error.	-
400	InvalidBizType	The bizType parameter is invalid.	The bizType parameter is invalid.
403	Forbidden.NoPermission	You are not authorized to access this page.	You are not authorized to access this page.

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

Change history

Change time	Summary of changes	Operation
2025-12-08	The Error code has changed. The response structure of the API has changed	View Change Details