ListImage API Overview for ECS Image Queries - App Streaming - Alibaba Cloud - App Streaming

Queries image information.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

appstreaming:ListImage

list

*All Resource

*

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 image status. Specifies the status of images to query. By default, all images that are not deleted are queried. Valid values: AVAILABLE : available. INIT : initializing. CREATE_FAILED : creation failed. CREATING : being created.	INIT
ImageType	string	No	The image type. Valid values: User : custom image. Shared : shared image. System : system image. Community : community image.	User
PackageType	string	No	The image package type. Valid values: Ecs_Container : ECS+Docker image. Ecs : ECS image.	Ecs
OsType	string	No	The operating system type of the image. Valid values: Linux : Linux Unknown : unknown. Windows : Windows Android : Android	Windows
BizType	integer	No	The business type. This parameter is not publicly available. Valid values: 1 : [Default value].	1
ProductType	string	No	The product type. Valid values: CloudDesktop : WUYING Workspace. CloudApp : WUYING CloudApp. WuyingServer : WUYING Workstation.	CloudApp
ProtocolType	string	No	The protocol type of the image. Valid values: HDX : HDX protocol. ASP : Alibaba Cloud proprietary ASP protocol.	ASP
PageSize	integer	No	The number of entries per page for paging queries. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number.	1
ProductTypeList	array	No	The list of products supported when the image supports multiple products.
	string	No	The product type. Valid values: CloudDesktop : WUYING Workspace. CloudApp : WUYING CloudApp. WuyingServer : WUYING Workstation.	CloudApp
BizTypeList	array	No	The list of all business types. This parameter is not publicly available.
	integer	No	The business type. Set this parameter based on your business. Valid values: 1 : [Default value].	1
FeatureList	array	No	The list of features supported by the image.
	string	No	The feature supported by the image. Valid values: FotaChannel : Supported FOTA channel. Builder : Supports image Builder. MultiSession : Supports multiple sessions. GPU : Supports GPU.	GPU
LanguageType	string	No	The language. Valid values: en-US : English. zh-HK : Traditional Chinese (Hong Kong). zh-CN : Simplified Chinese. ja-JP : Japanese.	zh-CN
ResourceInstanceType	string	No	Queries images of specific defined specifications.	eds.enterprise_office.2c4g
FotaVersion	string	No	The image version information.	2.0.3-xxxx
PlatformName	string	No	The operating system platform name. Valid values: Ubuntu : Ubuntu operating system. Debian : Debian operating system. Windows Server 2022 : Windows Server 2022 operating system. Windows Server 2019 : Windows Server 2019 operating system. Windows Server 2016 : Windows Server 2016 operating system. Windows 11 : Windows 11 operating system. Windows 10 : Windows 10 operating system.	Windows Server 2019
BizRegionIdList	array	No	The list of supported regions. WUYING 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 for query.
	object	No
Key	string	No	The custom tag key.	env
Value	string	No	The custom tag value.	test
PlatformNameList	array	No	The list of supported platform types. For valid values, refer to PlatformName above.
	string	No	The image platform name.	Windows 11
Distro	string	No

Response elements

Element	Type	Description	Example
	object	The image information struct.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number of the returned data.	1
Data	array<object>	The returned data object.
	array<object>	The returned object.
GmtCreate	string	The creation time.	2025-04-25 15:13:57
GmtModified	string	The update time.	2025-04-25 15:13:57
AliUid	integer	The tenant ID.	123456789
ImageId	string	The image ID. System image IDs are meaningful, while custom image IDs are automatically generated.	imgc-xxxx
ImageName	string	The image name.	DemoImage
ImageType	string	The image type.	User
PackageType	string	The image package type.	ECS
Description	string	The image description.	描述
OsType	string	The image type.	Windows
ProtocolType	string	The protocol type.	ASP
BizType	integer	The business type.	1
ProductType	string	The product type.	CloudApp
VersionId	string	The image version.	iv-xxx
OnlineVersionId	string	The sub-version from which the current image reads the primary image information. 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 image status.	INIT
ParentImageId	string	The parent image ID. This parameter indicates only the inheritance relationship. System images do not have a parent image.	imgc-xxx
ParentImageVersion	string	The parent image version.	iv-xxx
BaseImageId	string	The base image ID.	imgc-xxx
BaseImageVersion	string	The base image version.	iv-xxx
FotaVersion	string	The FOTA version.	2.3.0-xxx
Language	string	The image language. If the package type is VHD or Container, this property is inherited from the ECS-packaged image in the image combination.	zh-CN
Platform	integer	The operating system platform of the image. Note If the package type is VHD or Container, this property is inherited from the ECS-packaged image in the image combination.	Windows
OnlineVersion	boolean	Indicates whether the current version is the active version.	true
SystemDiskSize	integer	The system cloud disk size. Unit: GiB. Note The system cloud disk size cannot be smaller than the image file.	40
DataDiskSize	integer	The data cloud disk size. Unit: GiB.	100
AppList	array<object>	The application configurations.
	object
AppId	string	The ID of the application.	ca-xxx
AppName	string	The name of the application.	应用名称
FeatureList	array	The list of image feature tags.
	string	The image feature tag.	Builder
ImageCreateMode	string	The image creation type. Valid values: BY_SNAPSHOT_ID : Created from a snapshot or contains only a system cloud disk. BUILDER_MANUAL : Manually created image. INSTANCE_AUTO : Automatically created image based on an instance. BY_INSTANCE_ID : Created from an instance or contains both a system cloud disk and data cloud disks.	BUILDER_MANUAL
ImageRegionList	array	The regions.
	string	The region object.	地域对象。
Distro	string	The distribution name.	Ubuntu 22.04 64位
VersionName	string	The version name.	v0.1.0
ResourceInstanceCategory	string	The resource type supported by the image.	["eds.cpu.category"]
PlatformName	string	The system platform name.	Windows Server 2022
SupportedLanguageList	array	The list of supported languages.
	string	The supported language.	zh-CN
VolumeEncryptionEnabled	boolean	Indicates whether cloud disk encryption is enabled.	true
VolumeEncryptionKey	string	The KMS key ID used when cloud disk encryption is enabled.	a7b3c0c8-xxxx
SessionType	string	The session type. Valid values: SINGLE_SESSION : single session. MULTIPLE_SESSION : multiple sessions.	SINGLE_SESSION
ImageRegionDistributeList	array<object>	The effective region information for overlay layers.
	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 publicly available.	镜像支持的fota渠道，暂未启用
CompatibleMode	boolean	Indicates whether the compatibility mode is enabled.	true
DriverList	array	The list of driver information.
	string	The driver list.	["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
Scene	string		AIGC
Rating	integer		95
ImageIconUrl	string
EnvironmentId	string		env-164c321f405ca84143e4b730dbe4
TagList	array<object>
	object
Key	string		1630348213973321
Value	string		inner
SnapshotList	array<object>
	object
SnapshotId	string
VersionId	string
DiskType	string
DiskSubType	string
BindType	string
DiskCategory	string
Size	integer
Count	integer	The total number of entries.	22
Success	boolean	Indicates whether the call was successful. Valid values: true : The call was successful. false : The call failed.	true
Code	string	The error code.	200
Message	string	The message returned for the API request.	success
RequestId	string	The request ID.	8737D130-BFD0-5D51-96F6-C08EB1139A25

Examples

Success response

JSON format

{
  "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": "Ubuntu 22.04 64位",
      "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": "镜像支持的fota渠道，暂未启用",
      "CompatibleMode": true,
      "DriverList": [
        "[\"00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"]"
      ],
      "Scene": "AIGC",
      "Rating": 95,
      "ImageIconUrl": "",
      "EnvironmentId": "env-164c321f405ca84143e4b730dbe4",
      "TagList": [
        {
          "Key": "1630348213973321",
          "Value": "inner"
        }
      ],
      "SnapshotList": [
        {
          "SnapshotId": "",
          "VersionId": "",
          "DiskType": "",
          "DiskSubType": "",
          "BindType": "",
          "DiskCategory": "",
          "Size": 0
        }
      ]
    }
  ],
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.