All Products
Search

This Product

    Elastic Desktop Service:ExportDesktopListInfo

    Document Center

    Elastic Desktop Service:ExportDesktopListInfo

    Last Updated:Jun 11, 2026

    Exports a cloud computer list as a CSV file.

    Operation description

    The cloud computer list exported by calling this operation is saved as a CSV file. Each entry of data of a cloud computer includes the following fields:

    • Cloud computer ID and name

    • Office network ID and name

    • The instance type, OS and protocol of the cloud computer

    • System disk and data disk of the cloud computer

    • The status

    • Purchase method

    • The time when the cloud computer expires

    • Remaining duration and total duration

    • Number of assigned users and number of current users

    • Office network type

    • The time when the cloud computer was created

    • Tags

    • Encryption status

    • IP

    • The hostname

    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
    RegionId

    string

    Yes

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

    cn-hangzhou
    GroupId

    string

    No

    The ID of the computer pool to which the cloud computers belong.

    dg-boyczi8enfyc5***
    DesktopStatus

    string

    No

    The status of the cloud computers.

    Valid values:

    • Stopped

    • Starting

    • Rebuilding

    • Running

    • Stopping

    • Expired

    • Deleted

    • Pending

    Valid values:

    • Stopped :
    • Starting :
    • Rebuilding :
    • Running :
    • Stopping :
    • Expired :
    • Deleted :
    • Pending :

    Running
    MaxResults

    integer

    No

    The number of entries per page.

    Maximum value: 100.

    Default value: 10.

    10
    NextToken

    string

    No

    The token that is used for the next query. If this parameter is empty, all results are returned.

    caeba0bbb2be03f84eb48b699f0a4883
    UserName

    string

    No

    The username of the end user who is using the cloud computer.

    alice
    DesktopName

    string

    No

    The name of the cloud computer.

    DemoComputer01
    OfficeSiteId

    string

    No

    The office network ID.

    cn-hangzhou+dir-363353****
    PolicyGroupId

    string

    No

    The ID of the policy that is attached to the cloud computer.

    system-all-enabled-policy
    ChargeType

    string

    No

    The billing method of the cloud computer.

    Default value: Postpaid. Valid values:

    • Postpaid: pay-as-you-go

    • PrePaid: subscription

    Valid values:

    • PostPaid :
    • PrePaid :

    PostPaid
    ExpiredTime

    string

    No

    The time when a subscription cloud computer expires.

    2022-12-31T15:59Z
    DesktopId

    array

    No

    The IDs of the cloud computers. You can specify 1 to 100 IDs.

    string

    No

    The ID of a cloud computer.

    ecd-gx2x1dhsmucyy****
    EndUserId

    array

    No

    The IDs of the end users of the cloud computer. You can specify 1 to 100 IDs.

    Note

    During a specific period of time, only one user can connect to and use the cloud computer.

    string

    No

    The ID of an end user of the cloud computer.

    alice
    LangType

    string

    No

    The language in which the cloud computer is displayed in the console UI. You can export the list of cloud computers in the specified language.

    Default value: zh-CN. Valid values:

    • zh-CN: Simplified Chinese

    • en-GB: British English

    Valid values:

    • zh-CN :
    • en-GB :

    `zh-CN`
    Tag

    array<object>

    No

    The tags that are added to the cloud computer. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud computers by group. This facilitates search and batch operations. For more information, see Use tags to manage cloud computers.

    object

    No

    Key

    string

    No

    The tag key. If you specify the Tag parameter, you must also specify the Key parameter. The tag key can be up to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with acs: or aliyun and cannot contain only spaces.

    TestKey
    Value

    string

    No

    The tag value. The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with acs: or aliyun.

    TestValue

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of response.

    Url

    string

    The URL of the exported file of the cloud computer list.

    https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********
    RequestId

    string

    The ID of the request.

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****

    Examples

    Success response

    JSON format

    {
  "Url": "https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 ExportDesktop.UnknowError Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.