查询共享型云电脑列表及详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ecd:DescribeDesktopGroups | list | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 | cn-hangzhou |
| OfficeSiteId | string | 否 | 共享型云电脑所属的办公网络 ID。 | cn-hangzhou+dir-467671**** |
| DesktopGroupName | string | 否 | 要查询的共享型云电脑名称，支持模糊查询。 | CloudComputerPool01 |
| DesktopGroupId | string | 否 | 共享型云电脑 ID。 | dg-2i8qxpv6t1a03**** |
| Period | integer | 否 | 包年包月共享型云电脑的购买时长。单位由
| 1 |
| PeriodUnit | string | 否 | 包年包月计费方式的时长单位。 | Month |
| MaxResults | integer | 否 | 分页查询时每页行数。 最大值：100。 默认值：10。 | 10 |
| NextToken | string | 否 | 下一个查询开始的 Token，NextToken 为空表示没有下一个。 | caeba0bbb2be03f84eb48b699f0a4883 |
| PolicyGroupId | string | 否 | 共享型云电脑关联的策略 ID。 | pg-53iyi2aar0nd6**** |
| Status | integer | 否 | 共享型云电脑的状态。 枚举值：
| 1 |
| OwnType | long | 否 | 共享型云电脑类型。 说明
该参数暂未开放使用。
枚举值：
| 0 |
| EndUserIds | array | 否 | 共享型云电脑的授权用户 ID 列表。 | |
| string | 否 | 共享型云电脑的授权用户 ID。 | alice | |
| ExcludedEndUserIds | array | 否 | 要排除的已授权用户列表。 | |
| string | 否 | 要排除的已授权用户。 | Tony | |
| ProtocolType | string | 否 | 协议类型。 枚举值：
| ASP |
| ImageId | array | 否 | 镜像 ID 列表。 | |
| string | 否 | 镜像 ID。 | m-eeuo9qab4b0**** | |
| BundleId | array | 否 | 云电脑模板 ID 列表。 | |
| string | 否 | 云电脑模板 ID。 | b-4w5nk44znm6**** | |
| Tag | array<object> | 否 | 标签列表。可包含 1~20 个。 | |
| object | 否 | 标签。 | ||
| Key | string | 否 | 标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以 | TestKey |
| Value | string | 否 | 标签值。可以为空字符串。最多支持 128 个字符，不能以 | TestValue |
| MultiResource | boolean | 否 | 是否为多台共享类型的共享型云电脑。 枚举值：
| true |
| DesktopGroupIds | array | 否 | 共享型云电脑 ID 列表。 | |
| string | 否 | 共享型云电脑 ID。 | dg-2i8qxpv6t1a03**** |
返回参数
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"DesktopGroups": [
{
"CreateTime": "2022-02-17T14:51:07Z",
"PayType": "PrePaid",
"PolicyGroupName": "All enabled policy",
"Creator": "1007214305******",
"MaxDesktopsCount": 3,
"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": "CloudComputerPool01",
"SystemDiskCategory": "cloud_ssd",
"OfficeSiteId": "cn-hangzhou+dir-467671****",
"KeepDuration": 180000,
"MinDesktopsCount": 1,
"EndUserCount": 1,
"DataDiskSize": "50",
"DesktopGroupId": "dg-2i8qxpv6t1a03****",
"OfficeSiteName": "cn-hangzhou+os-c5cy7q578s8jc****",
"Cpu": 4,
"ExpiredTime": "2022-03-17T16:00:00Z",
"Comments": "comment",
"OfficeSiteType": "SIMPLE",
"Status": 1,
"ResetType": 0,
"LoadPolicy": 1,
"BindAmount": 2,
"OwnType": 0,
"ImageId": "m-gq15cq5ydlvwn****",
"VolumeEncryptionEnabled": false,
"VolumeEncryptionKey": "e5409ada-xxxx-xxxx-xxxx-89e31e23e993",
"RatioThreshold": 0.85,
"ConnectDuration": 3600000,
"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\\wuying\\users",
"IsLdap": true
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-03-24 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-01-24 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2024-06-14 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-08-01 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-03-17 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2021-11-04 | OpenAPI 入参发生变更 | 查看变更详情 |