All Products
Search

This Product

    Elastic Desktop Service:DescribeUserResources

    Document Center

    Elastic Desktop Service:DescribeUserResources

    Last Updated:Jun 11, 2026

    Queries a list of user resources.

    Operation description

    Before you call this operation, ensure that you understand the resource and product types of Wuying Workspace.

    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

    ClientId

    string

    Yes

    A unique ID generated by the client, similar to a UUID. This parameter is not sensitive and does not require encryption.

    54c17e1d-2d72-4b87-aa33-25f3b3f2****

    ClientType

    string

    No

    The type of the client.

    Valid values:

    • html5 :

      Web client

    • android :

      Android client

    • windows :

      Windows client

    • ios :

      iOS client

    • macos :

      macOS client

    windows

    ClientVersion

    string

    No

    The client version.

    7.6.0-R-20241112.222305

    LoginToken

    string

    Yes

    The logon credential. Obtain this token by calling the GetLoginToken operation. After you log on, you can also call the RefreshLoginToken operation to get an updated token. The token is returned in the `LoginToken` parameter.

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

    SessionId

    string

    No

    The session ID. Obtain this ID by calling the GetLoginToken operation.

    cd45e873-650d-4d70-acb9-f996187a****

    LoginRegionId

    string

    No

    The ID of the region where you log on. This parameter is required when you log on using an office network ID. You do not need to specify this parameter when you log on using an organization ID.

    cn-hangzhou

    SearchRegionId

    string

    No

    The ID of the region to search. This parameter filters for cloud resource information in the specified region.

    cn-hangzhou
    OfficeSiteIds

    array

    No

    A list of office network IDs. Specify this parameter when you log on with an Active Directory (AD) account.

    string

    No

    The office network ID.

    cn-hangzhou+dir-5440****
    ResourceTypes

    array

    No

    A list of resource types. If you leave this empty, all resource types are queried.

    string

    No

    The resource type.

    Valid values:

    • App :

      cloud application (including cloud apps, cloud phones, and cloud browsers)

    • Desktop :

      cloud desktop

    • DesktopGroup :

      shared cloud computer

    • CloudDrive :

      enterprise cloud drive

    Desktop
    ProductTypes

    array

    No

    A list of product types. If you leave this empty, all product types are queried.

    string

    No

    The product type.

    Valid values:

    • CloudDesktop :

      cloud desktop (including standard and shared cloud computers)

    • CloudApp :

      cloud application

    • CloudBrowser :

      cloud browser

    • AndroidCloud :

      cloud phone

    CloudApp
    ResourceIds

    array

    No

    A list of resource IDs. You can specify from 0 to 100 IDs.

    string

    No

    The resource ID.

    ecd-00001

    ResourceName

    string

    No

    The name of the resource. Fuzzy search is supported.

    testName

    ProtocolType

    string

    No

    The protocol type. This parameter is used only to filter cloud desktops.

    Valid values:

    • HDX :

      HDX protocol

    • ASP :

      Alibaba Cloud in-house ASP protocol

    ASP

    AccessType

    string

    No

    The access type. If you do not specify this parameter, resources of both access types are returned.

    Valid values:

    • INTERNET :

      Internet access

    • VPC :

      VPC access

    INTERNET

    Language

    string

    No

    The client language.

    Valid values:

    • en_US :

      English

    • zh_CN :

      Simplified Chinese

    • ja_JP :

      Japanese

    zh-CN

    CategoryType

    integer

    No

    The top-level resource category.

    1

    CategoryId

    integer

    No

    The second-level resource category.

    0

    QueryFotaUpdate

    boolean

    No

    Specifies whether to query the image version information of the cloud desktop.

    false

    RefreshFotaUpdate

    boolean

    No

    Specifies whether to refresh the over-the-air (OTA) information in real time.

    false

    OrderBy

    string

    No

    The field to use for sorting. If you do not specify this parameter, the results are sorted by creation time in descending order.

    Valid values:

    • CreateTime :

      resource creation time

    • AssignTime :

      resource authorization time

    AssignTime

    SortType

    string

    No

    The sort order.

    Valid values:

    • ASC :

      ascending order [Default]

    • DESC :

      descending order

    ASC

    MaxResults

    integer

    No

    The number of entries to return on each page for a paged query. Default value: 500.

    500

    NextToken

    string

    No

    The token for the next page.

    caeba0bbb2be03f84eb48b699f0a4883

    AutoRefresh

    boolean

    No

    Specifies whether to refresh immediately.

    Note

    To ensure a fast response, set this parameter to false.

    Valid values:

    • false :

      Does not refresh immediately.

    • true :

      Refreshes immediately.

    false

    Scene

    string

    No

    The client scenario, used to identify the sort order. Set the value to desktop.

    Valid values:

    • desktop :

      cloud desktop

    desktop

    DualCenterForwarddeprecated

    boolean

    No

    Specifies whether to use dual-center forwarding. Set the value to false.

    Valid values:

    • false :

      Dual-center forwarding is not used.

    false

    QueryDesktopTimers

    boolean

    No

    Specifies whether to query information about scheduled tasks for the cloud desktop. The default value is true.

    Valid values:

    • true :

      Yes. This is the default value.

    • false :

      No.

    true

    QueryDesktopDurationList

    boolean

    No

    Specifies whether to query information about cloud desktop plans. The default value is true.

    Valid values:

    • true :

      Yes. This is the default value.

    • false :

      No.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    NextToken

    string

    The token that marks the start of the next page of a paged query. If this parameter is empty, no more data is returned.

    AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****

    RequestId

    string

    The request ID.

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

    array

    A list of resource types for which the query failed.

    string

    The resource type.

    Valid values:

    • CloudDesktop :

      cloud desktop (including standard and shared cloud computers)

    • CloudApp :

      cloud application (including cloud apps, cloud phones, and cloud browsers)

    • CloudDrive :

      enterprise cloud drive

    CloudDesktop
    Resources

    array<object>

    A list of resource details.

    array<object>

    The resource details.

    AliUid

    integer

    The Alibaba Cloud account ID.

    194101959****

    ResourceType

    string

    The resource type.

    Valid values:

    • App :

      cloud application (including cloud apps, cloud phones, and cloud browsers)

    • Desktop :

      cloud desktop

    • DesktopGroup :

      shared cloud computer

    • CloudDrive :

      enterprise cloud drive

    Desktop

    RegionId

    string

    The region ID.

    cn-hangzhou

    RegionLocation

    string

    The location of the region.

    Valid values:

    • Mainland :

      a region in the Chinese mainland

    • Overseas :

      a region outside the Chinese mainland (including Hong Kong (China))

    Mainland

    ResourceGroupId

    string

    The resource group ID.

    dg-0****

    ResourceId

    string

    The resource ID.

    ecd-d19tya8zi4****

    ResourceLevel

    string

    The resource level.

    Valid values:

    • Center :

      centralized resource

    • Region :

      unitized resource

    Center

    CenterResourceId

    string

    The centralized resource ID.

    ecds-0****

    ResourceName

    string

    The resource name.

    testName01

    CreateTime

    string

    The time the resource was created.

    2024-12-11T07:12:12Z

    ProductType

    string

    The product type.

    Valid values:

    • CloudDesktop :

      cloud desktop (including standard and shared cloud computers)

    • CloudApp :

      cloud application

    • CloudBrowser :

      cloud browser

    • AndroidCloud :

      cloud phone

    AndroidCloud

    OfficeSiteId

    string

    The office network ID.

    cn-shanghai+dir-3367****

    AccessType

    string

    The access type.

    Valid values:

    • INTERNET :

      Internet access

    • VPC :

      VPC access

    • ANY :

      Both Internet and VPC access are supported.

    INTERNET

    ProtocolType

    string

    The protocol type.

    Valid values:

    • HDX :

      HDX protocol

    • ASP :

      Alibaba Cloud in-house ASP protocol

    ASP

    OsType

    string

    The operating system type.

    Valid values:

    • Linux :

      Linux

    • Windows :

      Windows

    • Android :

      Android

    Windows

    Os

    string

    Information about the operating system platform.

    Windows Server 2022

    OsDescription

    string

    A description of the operating system platform.

    Windows Genuine License

    SupportHibernation

    boolean

    Indicates whether hibernation is supported.

    Valid values:

    • true :

      Hibernation is supported.

    • false :

      Hibernation is not supported.

    true

    HibernationBeta

    boolean

    Indicates whether this is a beta version for hibernation testing.

    Valid values:

    • true :

      This is a beta version for hibernation testing.

    • false :

      This is not a beta version for hibernation testing.

    false

    SessionType

    string

    The session type.

    Valid values:

    • SINGLE_SESSION :

      single-session

    • MULTIPLE_SESSION :

      multi-session

    SINGLE_SESSION

    ChargeType

    string

    The billing method.

    Valid values:

    • PostPaid :

      pay-as-you-go [Default]

    • PrePaid :

      subscription

    PrePaid

    SubPayType

    string

    The sub-billing method.

    Valid values:

    • monthPackage :

      monthly subscription

    • PrePaid :

      duration plan

    PrePaid

    ExpiredTime

    string

    The expiration time for subscription resources.

    2025-02-22T16:00:00Z

    AuthMode

    string

    The authorization mode for the cloud application.

    Valid values:

    • App :

      application authorization

    • AppInstanceGroup :

      delivery group authorization

    • Session :

      session authorization

    App

    AppId

    string

    The application ID. This parameter is specific to resources of the `App` type.

    app-0001

    Version

    string

    The resource version. This parameter is specific to resources of the `App` type.

    Resource version.

    CategoryType

    integer

    The top-level resource category. This parameter is specific to resources of the `App` type.

    1

    CategoryId

    integer

    The second-level resource category. This parameter is specific to resources of the `App` type.

    0

    Icon

    string

    The URL of the resource icon. This parameter is specific to resources of the `App` type.

    http://example.com/icon.png

    ThemeColor

    string

    The theme color of the resource. This parameter is specific to resources of the `App` type.

    #FFFFFF

    CdsName

    string

    The name of the cloud drive. This parameter is specific to resources of the `CloudDrive` type.

    cn-shanghai+cds-695277****

    ExternalDomainId

    string

    The external domain ID. This parameter is specific to resources of the `CloudDrive` type.

    stg114510

    ExternalUserId

    string

    The external user ID. This parameter is specific to resources of the `CloudDrive` type.

    test001

    GlobalStatus

    boolean

    Indicates whether cross-region access is supported. This parameter is specific to resources of the `CloudDrive` type.

    true

    LocalName

    string

    The region name.

    China (Hangzhou)
    DesktopTimers

    array<object>

    A list of scheduled task settings for the cloud desktop.

    object

    The scheduled task settings for the cloud desktop.

    TimerType

    string

    The task type.

    TimerBoot

    CronExpression

    string

    The cron expression for the scheduled task.

    0 30 13 ? * 1-7

    Interval

    integer

    The interval for the scheduled task.

    15

    Enforce

    boolean

    Indicates whether the task is forcibly executed.

    false

    ResetType

    string

    The reset type.

    RESET_TYPE_SYSTEM

    AllowClientSetting

    string

    Indicates whether client-side settings are allowed.

    false

    OperationType

    string

    The operation type.

    Hibernate

    ExecutionTime

    string

    The execution time.

    2025-01-21T11:37Z
    Clients

    array<object>

    A list of client types supported by the resource.

    object

    Settings for a single client type supported by the resource.

    ClientType

    string

    The client type.

    windows

    Status

    string

    The support status.

    Valid values:

    • OFF :

      disabled

    • ON :

      enabled

    ON

    ResourceStatus

    string

    The resource status.

    Valid values:

    • Unknown :

      Unknown

    • Stopped :

      Stopped

    • Failed :

      Creation failed

    • Starting :

      Starting

    • Rebuilding :

      Rebuilding

    • Running :

      Running

    • Stopping :

      Stopping

    • FotaUpdating :

      Image is being upgraded.

    • Pending :

      Pending

    • Deleting :

      Deleting

    • Unavailable :

      Unavailable

    Running

    LastStartTime

    string

    The last time the resource was started.

    2025-01-24T03:12:04Z

    OrderStatus

    string

    The order status.

    Valid values:

    • Ceased :

      Overdue payment for a pay-as-you-go resource.

    • Released :

      The order is closed.

    • Expired :

      The subscription resource is stopped due to expiration.

    • Normal :

      Normal

    Normal
    ManagementStatuses

    array

    A list of management statuses.

    string

    The management status.

    NoFlag

    ResourceSessionStatus

    string

    The session status.

    Valid values:

    • Unknown :

      Unknown

    • Connected :

      Connected

    • Disconnected :

      Disconnected

    Connected
    Sessions

    array<object>

    A list of user session information for the resource.

    object

    The user session information for the resource.

    UserId

    string

    The username used to log on to the resource.

    user001

    UserPrincipalName

    string

    The User Principal Name (UPN) of the user to whom the resource is bound, if available. This parameter has a value only for the session of the current user who is making the query.

    benchmark_test@test.shenzhen

    ResourceSessionStartTime

    string

    The time when the resource session was connected.

    2025-01-22T11:03:36Z

    NickName

    string

    The user's nickname.

    user-001

    RealDesktopId

    string

    [shared cloud computer] The actual cloud desktop ID. This parameter is returned when a session exists on the shared cloud computer.

    ecd-0001

    UserCustomName

    string

    The custom name defined by the user.

    My Cloud Desktop
    FotaUpdate

    object

    The cloud desktop upgrade information.

    Project

    string

    The project name.

    wuying-asp_single_session_desktop_win_x64

    Channel

    string

    The channel.

    aliyun

    CurrentAppVersion

    string

    The current image version of the cloud desktop.

    2.7.0-R-20250122.154826

    NewAppVersion

    string

    The version to which the cloud desktop can be upgraded.

    2.7.0-R-20250125.154826

    Force

    boolean

    Indicates whether the upgrade is mandatory.

    false

    ReleaseNote

    string

    The description of the new version.

    New version

    Size

    string

    The size of the upgrade package. Unit: KB.

    474981930

    ReleaseNoteEn

    string

    The English description of the new version.

    new version

    ReleaseNoteJp

    string

    The Japanese description of the new version.

    新バージョン

    NewDcdVersion

    string

    The version of the component disk to which the cloud desktop can be upgraded.

    2.6.9-R-20250123.153415
    OsUpdate

    object

    The operating system upgrade information.

    CheckId

    string

    The check ID.

    wua-1740652957251743***

    PackageCount

    integer

    The number of packages.

    1
    Packages

    array<object>

    A list of patch package information.

    object

    The patch package information.

    Kb

    string

    The patch number.

    KB2267***

    Title

    string

    The patch title.

    A patch for ****.

    Description

    string

    The patch description.

    Installing this update modifies the files used to detect viruses, spyware, and other potentially unwanted software. Once installed, this update cannot be removed.

    KbListString

    string

    Information about the list of patch numbers.

    KB2267***

    UpdateCatalogUrl

    string

    The update category URL.

    https://catalog.update.microsoft.com/home.aspx

    HasUpgrade

    boolean

    Indicates whether an update exists.

    true
    DesktopDurationList

    array<object>

    A list of cloud desktop plan information.

    object

    The cloud desktop plan information.

    PackageCreationTime

    string

    The creation time.

    2025-01-17T07:01Z

    PackageStatus

    string

    The status.

    Available

    UsedDuration

    integer

    The used duration.

    16850

    PackageExpiredTime

    string

    The expiration time.

    2025-02-17T15:59Z

    PackageId

    string

    The plan ID.

    mdp-0bxls4qpi6bl6****

    TotalDuration

    integer

    The total duration.

    432000

    PackageType

    string

    The duration plan type.

    Valid values:

    • FREE_PACKAGE :

      free plan

    • NORMAL_PACKAGE :

      paid plan (120-hour plan)

    • POSTPAID_PACKAGE :

      used to record the pay-as-you-go quota plan (200-hour plan)

    • Duration :

      duration plan

    NORMAL_PACKAGE

    PeriodStartTime

    string

    The start time of the monthly plan.

    2025-01-17T07:01Z

    PeriodEndTime

    string

    The end time of the monthly plan.

    2025-02-17T15:59Z

    PostPaidLimitFee

    number

    The capped amount for the second-stage plan.

    Note

    This parameter is returned only when `ResourceType` is POSTPAID_PACKAGE or FREE_PACKAGE.

    199

    OrderInstanceId

    string

    The order instance ID.

    mdp-0bxls4qpi6bl6****

    PackageUsedUpStrategy

    string

    The policy for the cloud desktop status after the monthly quota of the plan is used up.

    Valid values:

    • Shutdown :

      Shut down or hibernate.

    • Postpaid :

      Continue to use and pay on a pay-as-you-go basis.

    Postpaid

    ConnectionProperties

    string

    The connection properties, which is a JSON string. The client does not need to parse the content. When an application resource establishes a connection, this string is directly passed to the central resource control.

    {"authMode":"App"}
    SupportedActions

    array

    A list of supported operation types. Currently, this is supported only for cloud phones and cloud desktops (including shared cloud computers).

    string

    The operation type.

    Valid values:

    • WakeUp :

      Wake up

    • Hibernate :

      Hibernate

    • Start :

      Start

    • Stop :

      Stop

    • Restart :

      Restart

    Start

    SupportAgentIm

    boolean

    AgentImUrl

    string

    https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx

    RankVersion

    integer

    The version number of the sorting data.

    1732869815062

    TotalCount

    integer

    The total number.

    10

    MaxResults

    integer

    The maximum number of returned entries.

    100
    AgentBriefSummary

    object

    TotalCount

    integer

    10
    AgentBriefs

    array<object>

    object

    AgentPlatform

    string

    ENTERPRISE_JVS

    AgentProvider

    string

    OpenClaw

    Count

    integer

    2

    AvatarUrl

    string

    https://abc.com/efg.png

    Url

    string

    https://test.png

    DisplayName

    string

    JVS Claw

    SubTitle

    string

    Claw

    AvatarNoResourceUrl

    string

    https://xxx.png

    Not all response parameters are available for every resource. Ensure that you know which parameters are returned for each resource type.

    Examples

    Success response

    JSON format

    {
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "QueryFailedResourceTypes": [
    "CloudDesktop"
  ],
  "Resources": [
    {
      "AliUid": 0,
      "ResourceType": "Desktop",
      "RegionId": "cn-hangzhou",
      "RegionLocation": "Mainland",
      "ResourceGroupId": "dg-0****",
      "ResourceId": "ecd-d19tya8zi4****",
      "ResourceLevel": "Center",
      "CenterResourceId": "ecds-0****",
      "ResourceName": "testName01",
      "CreateTime": "2024-12-11T07:12:12Z",
      "ProductType": "AndroidCloud",
      "OfficeSiteId": "cn-shanghai+dir-3367****",
      "AccessType": "INTERNET",
      "ProtocolType": "ASP",
      "OsType": "Windows",
      "Os": "Windows Server 2022",
      "OsDescription": "Windows Genuine License",
      "SupportHibernation": true,
      "HibernationBeta": false,
      "SessionType": "SINGLE_SESSION",
      "ChargeType": "PrePaid",
      "SubPayType": "PrePaid",
      "ExpiredTime": "2025-02-22T16:00:00Z",
      "AuthMode": "App",
      "AppId": "app-0001",
      "Version": "Resource version.",
      "CategoryType": 1,
      "CategoryId": 0,
      "Icon": "http://example.com/icon.png",
      "ThemeColor": "#FFFFFF",
      "CdsName": "cn-shanghai+cds-695277****",
      "ExternalDomainId": "stg114510",
      "ExternalUserId": "test001",
      "GlobalStatus": true,
      "LocalName": "China (Hangzhou)",
      "DesktopTimers": [
        {
          "TimerType": "TimerBoot",
          "CronExpression": "0 30 13 ? * 1-7",
          "Interval": 15,
          "Enforce": false,
          "ResetType": "RESET_TYPE_SYSTEM",
          "AllowClientSetting": "false",
          "OperationType": "Hibernate",
          "ExecutionTime": "2025-01-21T11:37Z"
        }
      ],
      "Clients": [
        {
          "ClientType": "windows",
          "Status": "ON"
        }
      ],
      "ResourceStatus": "Running",
      "LastStartTime": "2025-01-24T03:12:04Z",
      "OrderStatus": "Normal",
      "ManagementStatuses": [
        "NoFlag"
      ],
      "ResourceSessionStatus": "Connected",
      "Sessions": [
        {
          "UserId": "user001",
          "UserPrincipalName": "benchmark_test@test.shenzhen",
          "ResourceSessionStartTime": "2025-01-22T11:03:36Z",
          "NickName": "user-001"
        }
      ],
      "RealDesktopId": "ecd-0001",
      "UserCustomName": "My Cloud Desktop",
      "FotaUpdate": {
        "Project": "wuying-asp_single_session_desktop_win_x64",
        "Channel": "aliyun",
        "CurrentAppVersion": "2.7.0-R-20250122.154826",
        "NewAppVersion": "2.7.0-R-20250125.154826",
        "Force": false,
        "ReleaseNote": "New version",
        "Size": "474981930",
        "ReleaseNoteEn": "new version",
        "ReleaseNoteJp": "新バージョン",
        "NewDcdVersion": "2.6.9-R-20250123.153415"
      },
      "OsUpdate": {
        "CheckId": "wua-1740652957251743***",
        "PackageCount": 1,
        "Packages": [
          {
            "Kb": "KB2267***",
            "Title": "A patch for ****.",
            "Description": "Installing this update modifies the files used to detect viruses, spyware, and other potentially unwanted software. Once installed, this update cannot be removed."
          }
        ],
        "KbListString": "KB2267***",
        "UpdateCatalogUrl": "https://catalog.update.microsoft.com/home.aspx"
      },
      "HasUpgrade": true,
      "DesktopDurationList": [
        {
          "PackageCreationTime": "2025-01-17T07:01Z",
          "PackageStatus": "Available",
          "UsedDuration": 16850,
          "PackageExpiredTime": "2025-02-17T15:59Z",
          "PackageId": "mdp-0bxls4qpi6bl6****",
          "TotalDuration": 432000,
          "PackageType": "NORMAL_PACKAGE",
          "PeriodStartTime": "2025-01-17T07:01Z",
          "PeriodEndTime": "2025-02-17T15:59Z",
          "PostPaidLimitFee": 199,
          "OrderInstanceId": "mdp-0bxls4qpi6bl6****",
          "PackageUsedUpStrategy": "Postpaid"
        }
      ],
      "ConnectionProperties": "{\"authMode\":\"App\"}",
      "SupportedActions": [
        "Start"
      ],
      "SupportAgentIm": false,
      "AgentImUrl": "https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx"
    }
  ],
  "RankVersion": 1732869815062,
  "TotalCount": 10,
  "MaxResults": 100,
  "AgentBriefSummary": {
    "TotalCount": 10,
    "AgentBriefs": [
      {
        "AgentPlatform": "ENTERPRISE_JVS",
        "AgentProvider": "OpenClaw",
        "Count": 2,
        "AvatarUrl": "https://abc.com/efg.png",
        "Url": "https://test.png",
        "DisplayName": "JVS Claw",
        "SubTitle": "Claw",
        "AvatarNoResourceUrl": "https://xxx.png"
      }
    ]
  }
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.