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

Returns information about 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

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 ID of the image.	img-bp13mu****
ImageName	string	No	The name of the image. Fuzzy search is supported.	DemoImage
Status	string	No	The status of the image. Use this parameter to query for images with a specific status. If you omit this parameter, the call returns all non-deleted images. Valid values: AVAILABLE : available INIT : initializing CREATE_FAILED : creation failed CREATING : creating	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 package type of the image. Valid values: Ecs_Container : ECS + Docker image Ecs : ECS image	Ecs
OsType	string	No	The operating system of the image. Valid values: Linux : Linux Unknown : unknown Windows : Windows Android : Android	Windows
BizType	integer	No	The business type. This parameter is for internal use only. Valid values: 1 : Default	1
ProductType	string	No	The product type. Valid values: CloudDesktop : Elastic Desktop Service CloudApp : Wuying App Streaming WuyingServer : Wuying Workspace	CloudApp
ProtocolType	string	No	The streaming protocol. Valid values: HDX : HDX protocol ASP : The proprietary ASP protocol from Alibaba Cloud.	ASP
PageSize	integer	No	The number of entries per page. Maximum value: 100. Default value: 10.	10
PageNumber	integer	No	The page number.	1
ProductTypeList	array	No	The product types supported by the image.
	string	No	The product type. Valid values: CloudDesktop : Elastic Desktop Service CloudApp : Wuying App Streaming WuyingServer : Wuying Workspace	CloudApp
BizTypeList	array	No	The list of business types. This parameter is for internal use only.
	integer	No	The business type. Specify the value based on the service you are using. Valid values: 1 : Default	1
FeatureList	array	No	The features supported by the image.
	string	No	A feature that the image supports. Valid values: FotaChannel : Supports FOTA channels. Builder : Supports Image Builder. MultiSession : Supports multi-session. GPU : Supports GPU acceleration.	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	The instance type. Use this parameter to filter for images that are compatible with a specific instance type.	eds.enterprise_office.2c4g
FotaVersion	string	No	The version of the image.	2.0.3-xxxx
PlatformName	string	No	The name of the operating system platform. Valid values: Ubuntu : Ubuntu Debian : Debian 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 : The Windows 10 operating system	Windows Server 2019
BizRegionIdList	array	No	The IDs of regions to filter by. Wuying images are centralized. Use this parameter to find images that are available in the specified regions.
	string	No	The region ID.	cn-shanghai
TagList	array<object>	No	The tags by which to filter the results.
	object	No
Key	string	No	The key of the user-defined tag.	env
Value	string	No	The value of the user-defined tag.	test
PlatformNameList	array	No	The list of supported platform types. For valid values, see the `PlatformName` parameter.
	string	No	The platform name.	Windows 11
Distro	string	No

Response elements

Element	Type	Description	Example
	object	A data structure that contains the image information.
PageSize	integer	The number of entries to return on each page.	10
PageNumber	integer	The page number.	1
Data	array<object>	A list of objects that contain image details.
	array<object>	An object that contains the details of an image.
GmtCreate	string	The time when the image was created.	2025-04-25 15:13:57
GmtModified	string	The time when the image was last modified.	2025-04-25 15:13:57
AliUid	integer	The ID of the tenant.	123456789
ImageId	string	The ID of the image. The IDs of system images are predefined. The IDs of custom images are automatically generated.	imgc-xxxx
ImageName	string	The name of the image.	DemoImage
ImageType	string	The type of the image.	User
PackageType	string	The packaging type of the image.	ECS
Description	string	The description of the image.	描述
OsType	string	The operating system of the image.	Windows
ProtocolType	string	The streaming protocol.	ASP
BizType	integer	The business type.	1
ProductType	string	The product type.	CloudApp
VersionId	string	The version of the image.	iv-xxx
OnlineVersionId	string	The ID of the online image version. An image can have multiple versions.	iv-xxxx
LatestVersionId	string	The ID of the latest image version. An image can have multiple versions.	iv-xxx
Status	string	The status of the image.	INIT
ParentImageId	string	The ID of the parent image, which indicates an inheritance relationship. This field is empty for a system image.	imgc-xxx
ParentImageVersion	string	The version of the parent image.	iv-xxx
BaseImageId	string	The ID of the base image.	imgc-xxx
BaseImageVersion	string	The version of the base image.	iv-xxx
FotaVersion	string	The FOTA version.	2.3.0-xxx
Language	string	The language of the image. If the image is packaged as a `VHD` or `container`, this value is inherited from the `ECS`-packaged image in the same composition.	zh-CN
Platform	integer	The operating system platform of the image. Note If the image is packaged as a `VHD` or `container`, this value is inherited from the `ECS`-packaged image in the same composition.	Windows
OnlineVersion	boolean	Indicates whether the current version is the active version.	true
SystemDiskSize	integer	The size of the system disk, in GiB. Note The system disk size cannot be smaller than the image file size.	40
DataDiskSize	integer	The size of the data disk, in GiB.	100
AppList	array<object>	A list of application configurations.
	object
AppId	string	The ID of the application.	ca-xxx
AppName	string	The name of the application.	应用名称
FeatureList	array	A list of feature tags for the image.
	string	A feature tag of the image.	Builder
ImageCreateMode	string	The method used to create the image. Valid values: BY_SNAPSHOT_ID : Created from a snapshot and contains only a system disk. BUILDER_MANUAL : Created manually. INSTANCE_AUTO : Automatically created from an instance. BY_INSTANCE_ID : Created from an instance and contains both a system disk and a data disk.	BUILDER_MANUAL
ImageRegionList	array	A list of regions.
	string	A region.	地域对象。
Distro	string	The name of the distribution.	Ubuntu 22.04 64位
VersionName	string	The name of the version.	v0.1.0
ResourceInstanceCategory	string	The resource types that the image supports.	["eds.cpu.category"]
PlatformName	string	The name of the system platform.	Windows Server 2022
SupportedLanguageList	array	A list of supported languages.
	string	A supported language.	zh-CN
VolumeEncryptionEnabled	boolean	Indicates whether disk encryption is enabled.	true
VolumeEncryptionKey	string	The ID of the Key Management Service (KMS) key used for disk encryption. This parameter is returned only when disk encryption is enabled.	a7b3c0c8-xxxx
SessionType	string	The session type. Valid values: SINGLE_SESSION : The image supports only one user session per instance. MULTIPLE_SESSION : The image supports multiple concurrent user sessions on a single instance.	SINGLE_SESSION
ImageRegionDistributeList	array<object>	The distribution status of the image across different regions.
	object
ImageId	string	The ID of the image. The IDs of system images are predefined. The IDs of custom images are automatically generated.	imgc-xxx
RegionId	string	The supported region.	cn-shanghai
Status	string	The distribution status in this region.	INIT
VersionId	string	The version of the image.	iv-xxx
Progress	string	The distribution progress as a percentage.	70%
FotaChannel	string	Note This parameter is not available for external use.	镜像支持的fota渠道，暂未启用
CompatibleMode	boolean	Indicates whether the image is in compatibility mode.	true
DriverList	array	A list of driver IDs.
	string	A driver ID.	["00be80de-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]
Scene	string	The intended use case for the image.	AIGC
Rating	integer	The rating of the image.	95
ImageIconUrl	string	The URL of the image icon.
EnvironmentId	string	The ID of the environment.	env-164c321f405ca84143e4b730dbe4
TagList	array<object>	The tags that are added to the image.
	object
Key	string	The key of the tag.	1630348213973321
Value	string	The value of the tag.	inner
SnapshotList	array<object>	The snapshots of the image.
	object
SnapshotId	string	The ID of the snapshot.
VersionId	string	The ID of the image version.
DiskType	string	The type of the disk.
DiskSubType	string	The subtype of the disk.
BindType	string	The bind type.
DiskCategory	string	The category of the disk.
Size	integer	The size of the snapshot, in GiB.
Count	integer	The total number of entries returned.	22
Success	boolean	Indicates whether the request was successful. Valid values: true : The request was successful. false : The request failed.	true
Code	string	The response code.	200
Message	string	The response message.	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.