Queries the list of user resources.
Operation description
Before using this operation, make sure you are familiar with the resource types and product types of WUYING Workspace.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientId |
string |
Yes |
The unique ID generated by the client. Use a UUID format. This parameter is not a sensitive field and does not require encryption. |
54c17e1d-2d72-4b87-aa33-25f3b3f2**** |
| ClientType |
string |
No |
The type of the client. Valid values:
|
windows |
| ClientVersion |
string |
No |
The version of the client. |
7.6.0-R-20241112.222305 |
| LoginToken |
string |
Yes |
The logon token.
Obtain this token by calling the |
v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b**** |
| SessionId |
string |
No |
The session ID. Obtain this ID by calling the |
cd45e873-650d-4d70-acb9-f996187a**** |
| LoginRegionId |
string |
No |
The region ID for logon, used in office network ID logon scenarios. This parameter is not required for organization ID logon scenarios. |
cn-hangzhou |
| SearchRegionId |
string |
No |
The region ID used to filter cloud resources in a specified region. |
cn-hangzhou |
| OfficeSiteIds |
array |
No |
The list of office network IDs. Required when logging on with an AD account. |
|
|
string |
No |
The office network ID. |
cn-hangzhou+dir-5440**** |
|
| ResourceTypes |
array |
No |
The list of resource types. If left empty, all resource types are queried. |
|
|
string |
No |
The resource type. Valid values:
|
Desktop |
|
| ProductTypes |
array |
No |
The list of product types. If left empty, all product types are queried. |
|
|
string |
No |
The product type. Valid values:
|
CloudApp |
|
| ResourceIds |
array |
No |
The list of resource IDs. You can specify 0 to 100 IDs. |
|
|
string |
No |
The resource ID. |
ecd-00001 |
|
| ResourceName |
string |
No |
The resource name. Supports fuzzy search. |
testName |
| ProtocolType |
string |
No |
The protocol type. This parameter is used only to filter cloud desktops. Valid values:
|
ASP |
| AccessType |
string |
No |
The access type. If not specified, both types are returned. Valid values:
|
INTERNET |
| Language |
string |
No |
The language of the client. Valid values:
|
zh-CN |
| CategoryType |
integer |
No |
The primary resource category. |
1 |
| CategoryId |
integer |
No |
The secondary resource category. |
0 |
| QueryFotaUpdate |
boolean |
No |
Specifies whether to query the image version information of cloud desktops. |
false |
| RefreshFotaUpdate |
boolean |
No |
Specifies whether to refresh OTA information in real time. |
false |
| OrderBy |
string |
No |
The sort field. If not specified, results are sorted by creation time in descending order. Valid values:
Valid values:
|
AssignTime |
| SortType |
string |
No |
The sort order. Valid values:
Valid values:
|
ASC |
| MaxResults |
integer |
No |
The number of rows per page for paging in 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 Valid values:
|
false |
| Scene |
string |
No |
The client scene, used to identify the sort order. Set this parameter to Valid values:
|
desktop |
DualCenterForward
deprecated
|
boolean |
No |
Specifies whether to use dual-center forwarding. Set this parameter to Valid values:
|
false |
| QueryDesktopTimers |
boolean |
No |
Specifies whether to query scheduled task information for cloud desktops. Default value: true. Valid values:
|
true |
| QueryDesktopDurationList |
boolean |
No |
Specifies whether to query cloud desktop package information. Default value: true. Valid values:
|
true |
| Uuid |
string |
No |
The client UUID. |
FE44BAFDD92308BDAFE01217F948XXXX |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| NextToken |
string |
The token that marks the beginning of the next page. If NextToken is empty, there are no more pages. |
AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL**** |
| RequestId |
string |
The request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| QueryFailedResourceTypes |
array |
The list of resource types for which the query failed. |
|
|
string |
The resource type. Valid values:
|
CloudDesktop |
|
| Resources |
array<object> |
The list of resource details. |
|
|
array<object> |
The resource details. |
||
| AliUid |
integer |
The Alibaba Cloud account ID. |
194101959**** |
| ResourceType |
string |
The resource type. Valid values:
|
Desktop |
| RegionId |
string |
The region ID. |
cn-hangzhou |
| RegionLocation |
string |
The region location. Valid values:
|
Mainland |
| ResourceGroupId |
string |
The resource group ID. |
dg-0**** |
| ResourceId |
string |
The resource ID. |
ecd-d19tya8zi4**** |
| ResourceLevel |
string |
The resource level. Valid values:
|
Center |
| CenterResourceId |
string |
The centralized resource ID. |
ecds-0**** |
| ResourceName |
string |
The resource name. |
testName01 |
| CreateTime |
string |
The time when the resource was created. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2024-12-11T07:12:12Z |
| ProductType |
string |
The product type. Valid values:
|
AndroidCloud |
| OfficeSiteId |
string |
The office network ID. |
cn-shanghai+dir-3367**** |
| AccessType |
string |
The access type. Valid values:
|
INTERNET |
| ProtocolType |
string |
The protocol type. Valid values:
|
ASP |
| OsType |
string |
The operating system type. Valid values:
|
Windows |
| Os |
string |
The operating system platform information. |
Windows Server 2022 |
| OsDescription |
string |
The operating system platform description. |
Windows Genuine License |
| SupportHibernation |
boolean |
Specifies whether hibernation is supported. Valid values:
|
true |
| HibernationBeta |
boolean |
Specifies whether this is a beta version for hibernation. Valid values:
|
false |
| SessionType |
string |
The session type. Valid values:
|
SINGLE_SESSION |
| ChargeType |
string |
The billing method. Valid values:
|
PrePaid |
| SubPayType |
string |
The sub-billing method. Valid values:
|
PrePaid |
| ExpiredTime |
string |
The expiration time of subscription resources. The time follows the ISO 8601 standard and is in UTC (indicated by Z). |
2025-02-22T16:00:00Z |
| AuthMode |
string |
The cloud application authorization mode. Valid values:
|
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 primary category of the resource. This parameter is specific to resources of the App type. |
1 |
| CategoryId |
integer |
The secondary category of the resource. This parameter is specific to resources of the App type. |
0 |
| Icon |
string |
The resource icon URL. This parameter is specific to resources of the App type. |
http://example.com/icon.png |
| ThemeColor |
string |
The resource theme color. This parameter is specific to resources of the App type. |
#FFFFFF |
| CdsName |
string |
The cloud disk name. 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 |
Specifies 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> |
The list of scheduled task settings for cloud computers. |
|
|
object |
The scheduled task settings for a cloud computer. |
||
| 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 |
Specifies whether to enforce execution. |
false |
| ResetType |
string |
The reset type. |
RESET_TYPE_SYSTEM |
| AllowClientSetting |
string |
Specifies whether client-side configuration is allowed. |
false |
| OperationType |
string |
The operation type. |
Hibernate |
| ExecutionTime |
string |
The execution time. The time follows the ISO 8601 standard and is in UTC (indicated by Z). |
2025-01-21T11:37Z |
| Clients |
array<object> |
The list of client types supported by the resource. |
|
|
object |
The settings for a single client type supported by the resource. |
||
| ClientType |
string |
The client type. |
windows |
| Status |
string |
The support status. Valid values:
|
ON |
| ResourceStatus |
string |
The resource status. Valid values:
|
Running |
| LastStartTime |
string |
The last start time of the resource. The time follows the ISO 8601 standard and is in UTC (indicated by Z). |
2025-01-24T03:12:04Z |
| OrderStatus |
string |
The order status. Valid values:
|
Normal |
| ManagementStatuses |
array |
The management status list. |
|
|
string |
The management status. |
NoFlag |
|
| ResourceSessionStatus |
string |
The session status. Valid values:
|
Connected |
| Sessions |
array<object> |
The 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 UPN of the user associated with the resource (if any). This field has a value only for the session of the current querying user. |
benchmark_test@test.shenzhen |
| ResourceSessionStartTime |
string |
The time when the resource session was connected. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2025-01-22T11:03:36Z |
| NickName |
string |
The nickname of the user. |
user-001 |
| LastClientIp |
string |
The client IP address from which the user last logged on. |
1.2.3.4:22068 |
| RealDesktopId |
string |
[Shared cloud computer] The real cloud computer ID, present when the shared cloud computer has an active session. |
ecd-0001 |
| UserCustomName |
string |
The user-defined name. |
My Cloud Computer |
| FotaUpdate |
object |
The upgrade information for the cloud computer. |
|
| 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 computer. |
2.7.0-R-20250122.154826 |
| NewAppVersion |
string |
The version to which the cloud computer can be upgraded. |
2.7.0-R-20250125.154826 |
| Force |
boolean |
Specifies whether the upgrade is forced. |
false |
| ReleaseNote |
string |
The description of the version to which the cloud computer can be upgraded. |
New version |
| Size |
string |
The installation package size of the version to which the cloud computer can be upgraded. Unit: KB. |
474981930 |
| ReleaseNoteEn |
string |
The English description of the version to which the cloud computer can be upgraded. |
new version |
| ReleaseNoteJp |
string |
The Japanese description of the version to which the cloud computer can be upgraded. |
新バージョン |
| NewDcdVersion |
string |
The component disk version to which the cloud computer 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> |
The list of patch package information. |
|
|
object |
The patch package information. |
||
| Kb |
string |
The patch number. |
KB2267*** |
| Title |
string |
The patch title. |
Patch for **** |
| Description |
string |
The patch description. |
Install this update to modify the files used to detect viruses, spyware, and other potentially unwanted software. Once installed, this update cannot be removed |
| KbListString |
string |
The patch number list information. |
KB2267*** |
| UpdateCatalogUrl |
string |
The update catalog URL. |
https://catalog.update.microsoft.com/home.aspx |
| HasUpgrade |
boolean |
Indicates whether an update is available. |
true |
| DesktopDurationList |
array<object> |
The list of cloud computer package information. |
|
|
object |
The cloud computer package information. |
||
| PackageCreationTime |
string |
The creation time. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2025-01-17T07:01Z |
| PackageStatus |
string |
The status. |
Available |
| UsedDuration |
integer |
The used duration. |
16850 |
| PackageExpiredTime |
string |
The expiration time. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2025-02-17T15:59Z |
| PackageId |
string |
The package ID. |
mdp-0bxls4qpi6bl6**** |
| TotalDuration |
integer |
The total duration. |
432000 |
| PackageType |
string |
The duration package type. Valid values:
|
NORMAL_PACKAGE |
| PeriodStartTime |
string |
The start time of the current month package. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2025-01-17T07:01Z |
| PeriodEndTime |
string |
The end time of the current month package. The time follows the ISO 8601 standard in UTC (indicated by Z). |
2025-02-17T15:59Z |
| PostPaidLimitFee |
number |
The maximum fee cap for the second-phase package. Note
Returned only when ResourceType is |
199 |
| OrderInstanceId |
string |
The order instance ID. |
mdp-0bxls4qpi6bl6**** |
| PackageUsedUpStrategy |
string |
The status policy for cloud desktops after the monthly package quota is used up. Valid values:
|
Postpaid |
| ConnectionProperties |
string |
The connection properties in JSON string format. The client does not need to parse the content. When an application resource establishes a connection, this value is passed directly to the central resource management service. |
{"authMode":"App"} |
| SupportedActions |
array |
The list of supported operation types. Currently only cloud phones and cloud desktops (including shared cloud desktops) are supported. |
|
|
string |
The operation type. Valid values:
|
Start |
|
| SupportAgentIm |
boolean |
Specifies whether AgentIM is supported. |
|
| AgentImUrl |
string |
The URL of the AgentIm page. |
https://wuying.alibabacloud.com/OpenIM/chat?desktopId=ecd-xxxxx |
| Cpu |
integer |
The number of CPU cores. |
4 |
| Memory |
integer |
The memory size, in MB. |
4096 |
| GpuSpec |
string |
The GPU specifications. |
40GiB |
| Disks |
array<object> |
The list of disk information. |
|
|
object |
The disk information. |
||
| DiskType |
string |
The disk type. Valid values:
|
SYSTEM |
| DiskSize |
integer |
The disk size, in GB. |
300 |
| AgentProviderList |
array |
The list of Agent providers. |
|
|
string |
The Agent provider. Valid values:
|
AgenticComputer |
|
| RankVersion |
integer |
The sort data version number. |
1732869815062 |
| TotalCount |
integer |
The total count. |
10 |
| MaxResults |
integer |
The maximum number of results returned. |
100 |
| AgentBriefSummary |
object |
The Agent brief summary information. |
|
| TotalCount |
integer |
The total number of Agent instances. |
10 |
| AgentBriefs |
array<object> |
The list of Agent instance type summary information. |
|
|
object |
The Agent instance type summary information. |
||
| AgentPlatform |
string |
The Agent platform. |
ENTERPRISE_JVS |
| AgentProvider |
string |
The Agent provider. Valid values:
|
OpenClaw |
| Count |
integer |
The count. |
2 |
| AvatarUrl |
string |
The download URL of the default avatar for this Agent type. The backend automatically returns different avatars based on ClientType. If no match is found, a generic avatar is returned. |
https://abc.com/efg.png |
| Url |
string |
The URL of the Agent management page. |
https://test.png |
| DisplayName |
string |
The display name, such as JVS Claw. The backend automatically returns different display names based on Language. |
JVS Claw |
| SubTitle |
string |
The subtitle, such as: 智在进化 快乐养虾. The backend automatically returns different subtitles based on Language. |
智在进化,快乐养虾 |
| AvatarNoResourceUrl |
string |
The download URL of the default avatar for this Agent type when no cloud resources are available. The backend automatically returns different avatars based on ClientType. If no match is found, a generic avatar is returned. |
https://xxx.png |
| PcAvatarUrl |
string |
The download URL of the default PC avatar for this Agent type. |
https://xxx.png |
| Watermark |
string |
The avatar watermark URL for this Agent type, selected based on client type. |
https://xxxx.png |
Not all resources have the same response elements. Make sure you understand which parameter fields each resource type supports.
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",
"LastClientIp": "1.2.3.4:22068"
}
],
"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": "Patch for ****",
"Description": "Install this update to modify the files used to detect viruses, spyware, and other potentially unwanted software. Once installed, this item 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.alibabacloud.com/OpenIM/chat?desktopId=ecd-xxxxx",
"Cpu": 4,
"Memory": 4096,
"GpuSpec": "40GiB",
"Disks": [
{
"DiskType": "SYSTEM",
"DiskSize": 300
}
],
"AgentProviderList": [
"AgenticComputer"
]
}
],
"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": "Evolving Intelligence, Happy Shrimp Farming",
"AvatarNoResourceUrl": "https://xxx.png",
"PcAvatarUrl": "https://xxx.png",
"Watermark": "https://xxxx.png"
}
]
}
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.