All Products
Search

This Product

    WUYING Workspace:ExportDesktopListInfo

    Document Center

    WUYING Workspace:ExportDesktopListInfo

    Last Updated:Apr 08, 2024

    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

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    GroupIdstringNo

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

    		dg-boyczi8enfyc5***
    DesktopStatusstringNo

    The status of the cloud computers.

    Valid values:

    • Stopped

    • Starting

    • Rebuilding

    • Running

    • Stopping

    • Expired

    • Deleted

    • Pending

    		Running
    MaxResultsintegerNo

    The number of entries per page.

    Maximum value: 100.

    Default value: 10.

    		10
    NextTokenstringNo

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

    		caeba0bbb2be03f84eb48b699f0a4883
    UserNamestringNo

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

    		alice
    DesktopNamestringNo

    The name of the cloud computer.

    		testName
    OfficeSiteIdstringNo

    The office network ID.

    		cn-hangzhou+dir-363353****
    PolicyGroupIdstringNo

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

    		system-all-enabled-policy
    ChargeTypestringNo

    The billing method of the cloud computer.

    Default value: Postpaid. Valid values:

    • Postpaid: pay-as-you-go

    • PrePaid: subscription

    		PostPaid
    ExpiredTimestringNo

    The time when a subscription cloud computer expires.

    		2022-12-31T15:59Z
    DesktopIdarrayNo

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

    stringNo

    The ID of a cloud computer.

    		ecd-gx2x1dhsmucyy****
    EndUserIdarrayNo

    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.
    stringNo

    The ID of an end user of the cloud computer.

    		alice
    LangTypestringNo

    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

    		`zh-CN`
    Tagobject []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.

    KeystringNo

    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
    ValuestringNo

    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 parameters

    ParameterTypeDescriptionExample
    object

    Schema of response.

    Urlstring

    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?**********
    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError message
    400ExportDesktop.UnknowErrorFailed to export desktop list. Please try again. If the problem still exists, submit a ticket.

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

    Change history

    Change timeSummary of changesOperation
    2022-10-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-07-07The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Tag