Queries cloud computer shares.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecd:DescribeDesktopGroups | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the regions supported by WUYING Workspace. | cn-hangzhou |
| OfficeSiteId | string | No | The ID of the office network in which the cloud computer share resides. | cn-hangzhou+dir-467671**** |
| DesktopGroupName | string | No | The name of the cloud computer share that you want to query. Fuzzy search is supported. | testName |
| DesktopGroupId | string | No | The ID of the cloud computer share. | dg-2i8qxpv6t1a03**** |
| Period | integer | No | The subscription duration of the cloud computer share. The unit is specified by
| 1 |
| PeriodUnit | string | No | The unit of the subscription duration. | Month |
| MaxResults | integer | No | The number of entries to return on each page. Valid values: 1 to 100. Default value: 10. | 10 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists. | caeba0bbb2be03f84eb48b699f0a4883 |
| PolicyGroupId | string | No | The ID of the applied policy. | pg-53iyi2aar0nd6**** |
| Status | integer | No | The status of the cloud computer share. Valid values:
| 1 |
| OwnType | long | No | The type of the cloud computer share. Note
This parameter is not publicly available.
Valid values:
| 0 |
| EndUserIds | array | No | The IDs of the users who can access the cloud computer share. | |
| string | No | The ID of the user who can access the cloud computer share. | Alice | |
| ExcludedEndUserIds | array | No | The authorized users that you want to exclude. | |
| string | No | The authorized user that you want to exclude. | Tony | |
| ProtocolType | string | No | The protocol type. Valid values:
| ASP |
| ImageId | array | No | The IDs of the images. | |
| string | No | The ID of the image. | m-eeuo9qab4b0**** | |
| BundleId | array | No | The IDs of the cloud computer templates. | |
| string | No | The ID of the cloud computer template. | b-4w5nk44znm6**** | |
| Tag | array<object> | No | The tags that you want to add to the cloud computer share. You can specify 1 to 20 tags. | |
| object | No | The tag that you want to add to the cloud computer share. | ||
| Key | string | No | The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with | TestKey |
| Value | string | No | The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with | TestValue |
| MultiResource | boolean | No | Specifies whether the cloud computer share is a many-to-many share. Valid values:
| true |
| DesktopGroupIds | array | No | The IDs of the cloud computer shares. | |
| string | No | The ID of the cloud computer share. | dg-2i8qxpv6t1a03**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"DesktopGroups": [
{
"CreateTime": "2022-02-17T14:51:07Z",
"PayType": "PrePaid",
"PolicyGroupName": "test-policy",
"Creator": "1007214305******",
"MaxDesktopsCount": 10,
"SystemDiskSize": 80,
"PolicyGroupId": "pg-53iyi2aar0nd6c8qj",
"OwnBundleId": "bundle_eds_general_4c8g_s8d5_win2019",
"GpuCount": 1,
"Memory": 16384,
"GpuSpec": "16 GiB",
"OwnBundleName": "test",
"DataDiskCategory": "cloud_ssd",
"DesktopGroupName": "test1",
"SystemDiskCategory": "cloud_ssd",
"OfficeSiteId": "cn-hangzhou+dir-467671****",
"KeepDuration": 1000,
"MinDesktopsCount": 1,
"EndUserCount": 1,
"DataDiskSize": 50,
"DesktopGroupId": "dg-2i8qxpv6t1a03****",
"OfficeSiteName": "testName",
"Cpu": 4,
"ExpiredTime": "2022-03-17T16:00:00Z",
"Comments": "test",
"OfficeSiteType": "SIMPLE",
"Status": 1,
"ResetType": 0,
"LoadPolicy": 1,
"BindAmount": 1,
"OwnType": 0,
"ImageId": "m-gq15cq5ydlvwn****",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "e5409ada-xxxx-xxxx-xxxx-89e31e23e993",
"RatioThreshold": 0.85,
"ConnectDuration": 90000,
"IdleDisconnectDuration": 90000,
"Version": 2,
"StopDuration": 900000,
"ProtocolType": "ASP",
"OsType": "Windows",
"BuyDesktopsCount": 5,
"DesktopCount": 2,
"DesktopType": "eds.enterprise_office.4c4g",
"CountPerStatus": [
{
"Status": "Running",
"Count": 10
}
],
"GpuDriverVersion": 12,
"SubnetId": "vsw-uf63bb6*****8gfytm",
"Tags": [
{
"Key": "desktop_group_name",
"Value": "ds-dq2mybjr23yw*****"
}
],
"UserOuPath": "example.com",
"IsLdap": true
}
]
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-10-24 | The response structure of the API has changed | View Change Details |
| 2025-04-09 | The response structure of the API has changed | View Change Details |
| 2025-03-24 | The response structure of the API has changed | View Change Details |
| 2025-01-24 | The request parameters of the API has changed | View Change Details |
| 2024-06-14 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-08-01 | The response structure of the API has changed | View Change Details |
| 2023-03-17 | The request parameters of the API has changed | View Change Details |
| 2021-11-04 | The request parameters of the API has changed | View Change Details |