首页 无影云桌面 开发参考 API参考（云桌面管控） API目录 桌面组 DescribeDesktopGroups - 查询桌面组

DescribeDesktopGroups - 查询桌面组

获取桌面组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring是

地域ID。

cn-hangzhou
OfficeSiteIdstring否

桌面组所属的工作区ID。

cn-hangzhou+dir-467671****
DesktopGroupNamestring否

要查询的桌面组名称，支持模糊查询。

testName
DesktopGroupIdstring否

桌面组ID。

dg-2i8qxpv6t1a03****
Periodinteger否

桌面组过期时长。单位由PeriodUnit指定。

1
PeriodUnitstring否

过期时间的类型。

枚举值：
  • Month：月。
  • Year：年。
  • Day：日。
Month
MaxResultsinteger否

分页查询时每页行数。 最大值：100。 默认值：10。

10
NextTokenstring否

下一个查询开始的Token，NextToken为空表示没有下一个。

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdstring否

桌面组关联的策略ID。

pg-53iyi2aar0nd6****
Statusinteger否

桌面组状态。

枚举值：
  • 0：未支付。
  • 1：正常。
  • 2：欠费或过期。
1
OwnTypelong否

桌面组类型。

枚举值：
  • 0：专有池化。
  • 1：共享池化（多会话）。
0
EndUserIdsarray否

已授权用户。

string否

已授权用户。

Alice
ExcludedEndUserIdsarray否

要排除的已授权用户。

string否

要排除的已授权用户。

Tony
ProtocolTypestring否

协议类型。取值范围：

  • ASP
  • HDX
ASP
ImageIdarray否

镜像ID列表。

string否

镜像ID。

m-eeuo9qab4b0****
BundleIdarray否

桌面模板ID列表。

string否

桌面模板ID。

b-4w5nk44znm6****

返回参数

名称类型描述示例值
object

返回对象。

NextTokenstring

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopGroupsobject []

桌面组列表。

CreateTimestring

创建时间。

2022-02-17T14:51:07Z
PayTypestring

付费类型。

枚举值：
  • PostPaid：按量付费。
  • PrePaid：包年包月。
PrePaid
PolicyGroupNamestring

策略名称。

test-policy
Creatorstring

创建者，即阿里云账号ID。

1007214305******
MaxDesktopsCountinteger

桌面组容纳的最大桌面数。

10
SystemDiskSizeinteger

系统盘容量。单位为GiB。

80
PolicyGroupIdstring

策略ID。

pg-53iyi2aar0nd6c8qj
OwnBundleIdstring

桌面模板ID。

bundle_eds_general_4c8g_s8d5_win2019
GpuCountfloat

GPU核数。

1
Memorylong

内存大小。单位为MiB。

16384
GpuSpecstring

GPU显存。

16 GiB
OwnBundleNamestring

桌面模板名称。

test
DataDiskCategorystring

数据盘类型。

枚举值：
  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD 云盘。
  • cloud_essd：ESSD 云盘。
cloud_ssd
DesktopGroupNamestring

桌面组名称。

test1
SystemDiskCategorystring

系统盘类型。

枚举值：
  • cloud_efficiency：高效云盘。
  • cloud_ssd：SSD 云盘。
  • cloud_essd：ESSD 云盘。
cloud_ssd
OfficeSiteIdstring

工作区ID。

cn-hangzhou+dir-467671****
KeepDurationlong

终端用户断开桌面连接后，桌面的保留时长。单位为ms。

1000
MinDesktopsCountinteger

桌面组必须保持的最小桌面数。

1
EndUserCountinteger

授权使用桌面组的用户数。

1
DataDiskSizestring

数据盘容量。单位为GiB。

50
DesktopGroupIdstring

桌面组ID。

dg-2i8qxpv6t1a03****
OfficeSiteNamestring

工作区名称。

testName
Cpuinteger

CPU核数。

4
ExpiredTimestring

包年包月桌面的到期时间。

2022-03-17T16:00:00Z
Commentsstring

备注信息。

test
OfficeSiteTypestring

工作区的账号系统类型。 可能值： -simple：便捷账号。 -ad_connector：企业ad账号。

枚举值：
  • PERSONAL：个人型工作区。
  • SIMPLE：便捷型工作区。
  • AD_CONNECTOR：AD 型工作区。
  • RAM：RAM 型工作区。
SIMPLE
Statusinteger

桌面组状态。

枚举值：
  • 0：未支付。
  • 1：正常。
  • 2：欠费或过期。
1
ResetTypelong

桌面重置类型。

枚举值：
  • 0：不重置。
  • 1：只重置系统。
  • 2：只重置数据盘。
  • 3：重置系统盘和数据盘。
0
LoadPolicylong

多会话桌面组负载策略。

枚举值：
  • 0：深度优先。
  • 1：广度优先。
1
BindAmountlong

多会话桌面组中，每台桌面允许的会话数。

1
OwnTypelong

桌面组类型。

枚举值：
  • 0：专有池化。
  • 1：共享池化（多会话）。
0
ImageIdstring

镜像ID。

m-gq15cq5ydlvwn****
VolumeEncryptionEnabledboolean

是否开启加密功能。

false
VolumeEncryptionKeystring

加密磁盘使用的KMS密钥ID。

e5409ada-xxxx-xxxx-xxxx-89e31e23e993
RatioThresholdfloat

会话占用率阈值，用作多会话桌面组的自动伸缩触发条件。会话占用率的计算公式为会话占用率 = 已绑定会话数 / (桌面资源总数 × 每台桌面支持的最多会话数) * 100%，当会话占用率达到该阈值时，触发新桌面的创建；未达到该阈值时，删除多余的桌面。

0.85
ConnectDurationlong

会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位：毫秒。只有池化模式下需要传入此参数。

90000
IdleDisconnectDurationlong

会话处于空闲状态（即没有键盘或鼠标输入）的最大时长。会话空闲时长达到此值时将自动断开连接。单位：毫秒。只有池化模式下需要传入此参数。

90000
Versioninteger

桌面组版本号。

2
StopDurationlong

空闲关机时间。当桌面空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。

900000
ProtocolTypestring

协议类型。取值范围：

  • ASP
  • HDX
ASP
OsTypestring

操作系统类型。取值范围：

  • Windows
  • Linux
Windows
BuyDesktopsCountinteger

购买桌面数，取值范围：0-200。

5

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-17OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：ImageId
    新增入参：BundleId
2021-11-04OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：EndUserIds
    新增入参：ExcludedEndUserIds
阿里云首页 无影云桌面 相关技术圈