DescribeUserResources - Elastic Desktop Service - Alibaba Cloud Documentation Center

Queries user resources.

Operation description

Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientId	string	Yes	The client ID. The system generates a unique ID for each client. This parameter is non-sensitive and does not need encryption.	54c17e1d-2d72-4b87-aa33-25f3b3f2****
ClientType	string	No	The client type. Valid values: html5: the web client. android: the Android client. windows: the Windows client. ios: the iOS client. macos: the macOS client.	windows
ClientVersion	string	No	The client version.	7.6.0-R-20241112.222305
LoginToken	string	Yes	The logon token. You can call the `GetLoginToken` or `RefreshLoginToken` operation to retrieve the logon token.	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
SessionId	string	Yes	The session ID. You can call the `GetLoginToken` operation to retrieve the session ID.	cd45e873-650d-4d70-acb9-f996187a****
LoginRegionId	string	No	The ID of the region where end users log on to clients. This parameter applies to office network ID-based logons. For organization ID-based logons, you can leave this parameter empty.	cn-hangzhou
SearchRegionId	string	No	The ID of the searched region. You can specify this parameter to filter cloud resources in specific regions.	cn-hangzhou
OfficeSiteIds	array	No	The office network IDs. This parameter is required for logons by using enterprise Active Directory (AD) accounts.
	string	No	The office network ID.	cn-hangzhou+dir-5440****
ResourceTypes	array	No	The resource types. If you leave this parameter empty, resources of all supported types will be queried.
	string	No	The resource type. Valid values: App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser. Desktop: cloud computers. DesktopGroup: cloud computer shares. CloudDrive: enterprise drives.	Desktop
ProductTypes	array	No	The service types. If you leave this parameter empty, services of all supported types will be queried.
	string	No	The service type. Valid values: CloudDesktop: regular cloud computers or cloud computer shares. CloudApp: App Streaming. CloudBrowser: Cloud Browser. AndroidCloud: Cloud Phone.	CloudApp
ResourceIds	array	No	The resource IDs. You can specify up to 100 resource IDs.
	string	No	The resource ID.	ecd-00001
ResourceName	string	No	The resource name. Fuzzy search is supported.	testName
ProtocolType	string	No	The protocol type. You can specify this parameter to filter cloud computers. Valid values: HDX: High-definition Experience (HDX). ASP: Adaptive Streaming Protocol (ASP).	ASP
AccessType	string	No	The access type. If you leave this parameter empty, both types will be displayed. Valid values: INTERNET: access over the Internet. VPC: access over an enterprise virtual private cloud (VPC).	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 level-1 resource category.	1
CategoryId	integer	No	The level-2 resource category.	0
QueryFotaUpdate	boolean	No	Specifies whether to return the image version information of cloud computers.	false
RefreshFotaUpdate	boolean	No	Specifies whether to refresh over-the-air (OTA) information in real time.	false
OrderBy	string	No	The sorting field. If you do not specify this parameter, resources are sorted by creation time by default. Valid values: CreateTime: the time when resources are created. AssignTime: the time when resources are assigned.	AssignTime
SortType	string	No	The sorting method. Valid values: ASC (default): the ascending order. DESC: the descending order.	ASC
MaxResults	integer	No	The number of entries per page. Default value: 500.	500
NextToken	string	No	A pagination token. It can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a4883
AutoRefresh	boolean	No	Specifies whether to enable the immediate refresh feature. Note To ensure the operation response speed, we recommend that you set the value to `false`. Valid values: false true	false
Scene	string	No	The client usage scenario. Set the value to `desktop`. Valid value: desktop: cloud computers.	desktop
DualCenterForward`deprecated`	boolean	No	Specifies whether to enable geo-redundant forwarding. Set the value to `false`. Valid value: false: disables geo-redundant forwarding.	false
QueryDesktopTimers	boolean	No	是否查询云电脑定时任务信息，默认为 true。 Enumeration Value: true: 是，默认值. false: 否.	true
QueryDesktopDurationList	boolean	No	是否查询云桌面套餐包信息，默认为 true。 Enumeration Value: true: 是，默认值. false: 否.	true

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
QueryFailedResourceTypes	array	The resource types that failed to be queried.
queryFailedResourceTypes	string	The resource type that failed to be queried. Valid values: CloudDesktop: regular cloud computers or cloud computer shares. CloudApp: cloud apps including App Streaming, Cloud Phone, and Cloud Browser. CloudDrive: enterprise drives.	CloudDesktop
Resources	array<object>	The resources.
Desktop	object	The resource.
AliUid	long	The ID of the Alibaba Cloud account.	194101959****
ResourceType	string	The resource type. Valid values: App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser. Desktop: cloud computers. DesktopGroup: cloud computer shares. CloudDrive: enterprise drives.	Desktop
RegionId	string	The region ID.	cn-hangzhou
RegionLocation	string	The geographical location. Valid values: Mainland: regions in the Chinese mainland. Overseas: regions outside the Chinese mainland, including China (Hong Kong).	Mainland
ResourceGroupId	string	The resource group ID.	dg-0****
ResourceId	string	The resource ID.	ecd-d19tya8zi4****
ResourceLevel	string	The resource level. Valid values: Center: a centralized resource. Region: a unit resource.	Center
CenterResourceId	string	The ID of the centralized resource.	ecds-0****
ResourceName	string	The resource name.	testName01
CreateTime	string	The time when the resource was created.	2024-12-11T07:12:12Z
ProductType	string	The service type. Valid values: CloudDesktop: regular cloud computers or cloud computer shares. CloudApp: App Streaming 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: access over the Internet. VPC: access over an enterprise VPC. ANY: access over the Internet or an enterprise VPC.	INTERNET
ProtocolType	string	The protocol type. Valid values: HDX ASP	ASP
OsType	string	The OS type. Valid values: Linux Windows Android	Windows
Os	string	The OS platform.	Windows Server 2022
OsDescription	string	The description of the OS platform.
SupportHibernation	boolean	Indicates whether hibernation is supported. Valid values: true false	true
HibernationBeta	boolean	Indicates whether this is a beta version of the hibernation feature. Valid values: true false	false
SessionType	string	The session type. Valid values: SINGLE_SESSION MULTIPLE_SESSION	SINGLE_SESSION
ChargeType	string	The billing method. Valid values: Postpaid (default): pay-as-you-go. PrePaid: subscription.	PrePaid
SubPayType	string	The sub-billing method. Valid values: monthPackage: monthly subscription. PrePaid: hourly plans.	PrePaid
ExpiredTime	string	The expiration time of the subscription resource.	2025-02-22T16:00:00Z
AuthMode	string	The authorization mode of the cloud app. Valid values: App: authorizes access to apps. AppInstanceGroup: authorizes access to delivery groups. Session: authorizes access to sessions.	App
AppId	string	The app ID. This parameter is for apps only.	app-0001
Version	string	The resource version. This parameter is for apps only.
CategoryType	integer	The level-1 resource category. This parameter is for apps only.	1
CategoryId	integer	The level-2 resource category. This parameter is for apps only.	0
Icon	string	The resource icon. This parameter is for apps only.	http://example.com/icon.png
ThemeColor	string	The theme color of the resource. This parameter is for apps only.	#FFFFFF
CdsName	string	The drive name. This parameter is for enterprise drives only.	cn-shanghai+cds-695277****
ExternalDomainId	string	The ID of the external domain. This parameter is for enterprise drives only.	stg114510
ExternalUserId	string	The ID of the external user. This parameter is for enterprise drives only.	test001
GlobalStatus	boolean	Indicates whether cross-region access is supported. This parameter is for enterprise drives only.	true
LocalName	string	The region name.
DesktopTimers	array<object>	The scheduled tasks for cloud computers.
DesktopTimer	object	The scheduled task.
TimerType	string	The task type.	TimerBoot
CronExpression	string	The cron expression specified in the scheduled task.	0 30 13 ? * 1-7
Interval	integer	The interval at which the scheduled task is executed.	15
Enforce	boolean	Indicates whether to forcibly execute the scheduled task.	false
ResetType	string	The reset option.	RESET_TYPE_SYSTEM
AllowClientSetting	string	Indicates whether to allow end users to configure scheduled tasks on clients.	false
OperationType	string	The type of the scheduled action.	Hibernate
ExecutionTime	string	The time when the scheduled task is executed.	2025-01-21T11:37Z
Clients	array<object>	The client types supported by resources.
Clients	object	The client type supported by resources.
ClientType	string	The client type.	windows
Status	string	The status. Valid values: OFF ON	ON
ResourceStatus	string	The resource status. Valid values: Unknown: The resource status is unknown. Stopped: The resource is stopped. Failed: The resource failed to be created. Starting: The resource is being started. Rebuilding: The resource is changing. Running: The resource is running. Stopping: The resource is being stopped. FotaUpdating: The image is being updated. Pending: The resource is still being prepared. Deleting: The resource is being deleted. Unavailable: The resource is unavailable.	Running
LastStartTime	string	The time when the resource was last started.	2025-01-24T03:12:04Z
OrderStatus	string	The order status. Valid values: Ceased: Your account has an overdue payment. Released: The order is closed. Expired: The subscription resource has expired. Normal: The order is normal.	Normal
ManagementStatuses	array	The management status.
ManagementStatuses	string	The management state.	NoFlag
ResourceSessionStatus	string	The session status. Valid values: Unknown Connected Disconnected	Connected
Sessions	array<object>	The sessions established between users and resources.
Session	object	The session established between the user and the resource.
UserId	string	The username used to log on to the resource.	user001
UserPrincipalName	string	The User Principal Name (UPN) of the resource-bound user (if applicable). This parameter is returned only when you query the current user's sessions.	benchmark_test@test.shenzhen
ResourceSessionStartTime	string	The timestamp when the resource session was established.	2025-01-22T11:03:36Z
NickName	string	用户的昵称。	user-001
RealDesktopId	string	The real ID of the cloud computer (from a share). This parameter is returned only when the cloud computer share has ongoing sessions.	ecd-0001
UserCustomName	string	The custom name of the resource.
FotaUpdate	object	The update info of the cloud computer.
Project	string	The project name.	wuying-asp_single_session_desktop_win_x64
Channel	string	The channel.	aliyun
CurrentAppVersion	string	The current version number of the cloud computer's image.	2.7.0-R-20250122.154826
NewAppVersion	string	The target version number of the cloud computer's image.	2.7.0-R-20250125.154826
Force	boolean	Specifies whether to implement a forced update.	false
ReleaseNote	string	The version description of the cloud computer's image.	up
Size	string	The size of the update package for the cloud computer image. Unit: KB.	474981930
ReleaseNoteEn	string	The English release note for the new image version.	up
ReleaseNoteJp	string	The Japanese release note for the new image version.	up
NewDcdVersion	string	The latest version available for updating the component disk.	2.6.9-R-20250123.153415
OsUpdate	object	The update info of the OS.
CheckId	string	The ID of the check task.	wua-1740652957251743***
PackageCount	integer	The number of packets.	1
Packages	array<object>	The patch packages.
Package	object	The patch package.
Kb	string	The patch number.	KB2267***
Title	string	The patch title.
Description	string	The patch description.
KbListString	string	The patch numbers.	KB2267***
UpdateCatalogUrl	string	The update categorization URL.	https://catalog.update.microsoft.com/home.aspx
HasUpgrade	boolean	Indicates whether an update exists.	true
DesktopDurationList	array<object>	The cloud computer plans.
desktopDuration	object	The cloud computer plan.
PackageCreationTime	string	The time when the package was created.	2025-01-17T07:01Z
PackageStatus	string	The package status.	Available
UsedDuration	long	The subscription duration consumed.	16850
PackageExpiredTime	string	The expiration time of the package.	2025-02-17T15:59Z
PackageId	string	The package ID.	mdp-0bxls4qpi6bl6****
TotalDuration	long	The total duration.	432000
PackageType	string	The package type. Valid values: FREE_PACKAGE: a free package. NORMAL_PACKAGE: a paid package (120-hour computing plan). POSTPAID_PACKAGE: a pay-as-you-go package (200-hour computing plan). Duration: an hourly package.	NORMAL_PACKAGE
PeriodStartTime	string	The package's effective start time for the current month.	2025-01-17T07:01Z
PeriodEndTime	string	The package's effective end time for the current month.	2025-02-17T15:59Z
PostPaidLimitFee	float	The maximum fee for the package in the second phase. Note This parameter is returned if you set ResourceType to `POSTPAID_PACKAG` or `FREE_PACKAGE`.	199
OrderInstanceId	string	The ID of the instance order.	mdp-0bxls4qpi6bl6****
PackageUsedUpStrategy	string	The policy for the cloud computer status once the monthly package quota is exhausted. Valid values: Shutdown: The cloud computer enters the Stopped or Hibernated state. PostPaid: The cloud computer continues providing services that are billed on the pay-as-you-go basis.	Postpaid
ConnectionProperties	string	The connection attributes in JSON format. The client does not need to process the attributes; they are directly passed to the resource management center when the app resource is created.	{"authMode":"App"}
SupportedActions	array	The supported actions. This parameter is returned only for cloud computers or phones.
SupportedActions	string	The support action. Valid values: WakeUp: wakes up cloud computers or cloud phones. Hibernate: hibernates cloud computers or cloud phones. Start: starts cloud computers or cloud phones. Stop: stops cloud computers or cloud phones. Restart: restarts cloud computers or cloud phones.	Start
RankVersion	long	The version number of the ranking data.	1732869815062
TotalCount	integer	总数。	10
MaxResults	integer	返回最大数量。	100

This response parameter is not available for all resources. Ensure you know the fields for each resource.

Examples

Sample success responses

JSONformat

{
  "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": "",
      "SupportHibernation": true,
      "HibernationBeta": false,
      "SessionType": "SINGLE_SESSION",
      "ChargeType": "PrePaid",
      "SubPayType": "PrePaid",
      "ExpiredTime": "2025-02-22T16:00:00Z",
      "AuthMode": "App",
      "AppId": "app-0001",
      "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": "",
      "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": "",
      "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": "up",
        "Size": 474981930,
        "ReleaseNoteEn": "up",
        "ReleaseNoteJp": "up",
        "NewDcdVersion": "2.6.9-R-20250123.153415"
      },
      "OsUpdate": {
        "CheckId": "wua-1740652957251743***",
        "PackageCount": 1,
        "Packages": [
          {
            "Kb": "KB2267***",
            "Title": "",
            "Description": ""
          }
        ],
        "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"
      ]
    }
  ],
  "RankVersion": 1732869815062,
  "TotalCount": 10,
  "MaxResults": 100
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-02-25	The response structure of the API has changed	View Change Details