All Products
Search

This Product

    Elastic Desktop Service:DescribeImages

    Document Center

    Elastic Desktop Service:DescribeImages

    Last Updated:May 11, 2026

    Queries the 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

    ecd:DescribeImages

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. You can call the DescribeRegions operation to query the most recent region list.

    cn-hangzhou
    MaxResults

    integer

    No

    The maximum number of entries to return on each page.

    • Maximum value: 100.

    • Default value: 10.

    10
    NextToken

    string

    No

    The token that determines the start point of the next query. If you do not specify this parameter, all results are returned.

    caeba0bbb2be03f84eb48b699f0a4883
    ImageType

    string

    No

    The type of the image.

    Valid values:

    • SYSTEM :
    • CUSTOM :

    SYSTEM
    ImageStatus

    string

    No

    The state of the image.

    Valid values:

    • Creating :
    • Available :
    • CreateFailed :

    Available
    GpuCategory

    boolean

    No

    Specifies whether the images are GPU-accelerated images.

    Valid values:

    • true

    • false

    Valid values:

    • true :
    • false :

    false
    ProtocolType

    string

    No

    The protocol type.

    Valid values:

    • HDX: High-definition Experience (HDX) protocol

    • ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)

    Valid values:

    • HDX :
    • ASP :

    ASP
    LanguageType

    string

    No

    The language of the OS.

    Valid values:

    • en-US :
    • zh-HK :
    • zh-CN :
    • ja-JP :

    en-US
    DesktopInstanceType

    string

    No

    The instance type of the cloud computer. You can call the DescribeDesktopTypes operation to obtain the parameter value.

    ecd.graphics.xlarge
    ImageId

    array

    No

    The IDs of the images. You can specify one or more image IDs.

    m-gx2x1dhsmusr2****

    string

    No

    The ID of the image.

    m-gx2x1dhsmusr2****
    OsType

    string

    No

    The type of the operating system of the images. Default value: null.

    Valid values:

    • Linux

    • Windows

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    Windows
    GpuDriverVersion

    string

    No

    The version of the GPU driver.

    417.22
    SessionType

    string

    No

    The session type.

    Valid values:

    • SINGLE_SESSION :
    • MULTIPLE_SESSION :

    SINGLE_SESSION
    FotaVersion

    string

    No

    The image version.

    0.0.3-R-20220616.133609
    ImageName

    string

    No

    The image name.

    Win_01

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of response.

    NextToken

    string

    The token that determines the start point of the next query. If this parameter is empty, all results are returned.

    caeba0bbb2be03f84eb48b699f0a4883
    RequestId

    string

    The ID of the request.

    4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB
    Images

    array<object>

    The details of the images.

    object

    The details of the image.

    CreationTime

    string

    The time when the image was created.

    2018-01-10T01:01:10Z
    Status

    string

    The status of the image.

    Valid values:

    • Creating

    • Available

    • CreateFailed

    Valid values:

    • Creating :
    • Available :
    • CreateFailed :

    Available
    Progress

    string

    The creation progress of the image. Unit: %.

    100%
    DataDiskSize

    integer

    The size of the data disk. Unit: GiB.

    150
    ImageType

    string

    The type of the image.

    Valid values:

    • SYSTEM

    • CUSTOM

    Valid values:

    • SYSTEM :
    • CUSTOM :

    SYSTEM
    Description

    string

    The description of the image.

    This is description.
    Size

    integer

    The size of the image. Unit: GiB.

    40
    OsType

    string

    The type of the operating system.

    WINDOWS
    ProtocolType

    string

    The protocol type.

    Valid values:

    • HDX: High-definition Experience (HDX) protocol

    • ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)

    Valid values:

    • HDX :
    • ASP :

    ASP
    Name

    string

    The name of the image.

    testImageName
    ImageId

    string

    The ID of the image.

    m-gx2x1dhsmusr2****
    GpuCategory

    boolean

    Indicates whether the image is a GPU-accelerated image.

    false
    SupportedLanguages

    array

    The languages of the operating system.

    string

    The languages of the operating system. One or more languages are supported.

    Valid values:

    • en-US: American English.

    • zh-HK: traditional Chinese (Hong Kong, China)

    • zh-CN: simple Chinese

    • ja-JP: Japanese

    Valid values:

    • en-US :
    • zh-HK :
    • zh-CN :
    • ja-JP :

    en-US
    GpuDriverVersion

    string

    The version number of the GPU driver.

    417.22
    AppVersion

    string

    The version of the image.

    1.0.0
    VolumeEncryptionEnabled

    boolean

    Indicates whether disk encryption is enabled.

    false
    VolumeEncryptionKey

    string

    The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the ListKeys operation to query the list of KMS keys.

    08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
    SharedCount

    integer

    The number of shared images.

    1
    SessionType

    string

    The type of the image session.

    Valid values:

    • SINGLE_SESSION: single-session image.

    • MULTIPLE_SESSION: multi-session image.

    Valid values:

    • SINGLE_SESSION :
    • MULTIPLE_SESSION :

    MULTIPLE_SESSION
    UpdateTime

    string

    The time when the image was last modified.

    2021-12-22T02:48:43Z
    Platform

    string

    The operating system type of the image.

    Valid values:

    • Ubuntu

    • Windows Server 2022

    • UOS

    • CentOS

    • Windows Server 2019

    • SQL Server 2016

    • Windows 10

    Valid values:

    • Ubuntu :

      Ubuntu

    • Windows Server 2022 :

      Windows Server 2022

    • UOS :

      UOS

    • CentOS :

      CentOS

    • Windows Server 2019 :

      Windows Server 2019

    • Windows Server 2016 :

      Windows Server 2016

    • Windows 10 :

      Windows 10

    Windows Server 2019

    Examples

    Success response

    JSON format

    {
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
  "Images": [
    {
      "CreationTime": "2018-01-10T01:01:10Z",
      "Status": "Available",
      "Progress": "100%",
      "DataDiskSize": 150,
      "ImageType": "SYSTEM",
      "Description": "This is description.",
      "Size": 40,
      "OsType": "WINDOWS",
      "ProtocolType": "ASP",
      "Name": "testImageName",
      "ImageId": "m-gx2x1dhsmusr2****",
      "GpuCategory": false,
      "SupportedLanguages": [
        "en-US"
      ],
      "GpuDriverVersion": "417.22",
      "AppVersion": "1.0.0",
      "VolumeEncryptionEnabled": false,
      "VolumeEncryptionKey": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
      "SharedCount": 1,
      "SessionType": "MULTIPLE_SESSION",
      "UpdateTime": "2021-12-22T02:48:43Z",
      "Platform": "Windows Server 2019"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.