首页 无影云桌面 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
MaxResultsinteger

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

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdstring

桌面组关联的策略ID。

pg-53iyi2aar0nd6****
Statusinteger

桌面组状态。

1
OwnTypelong

桌面组类型。

0
EndUserIdsarray

已授权用户。

string

已授权用户。

Alice
ExcludedEndUserIdsarray

要排除的已授权用户。

string

要排除的已授权用户。

Tony

返回参数

名称类型描述示例值
object

返回对象。

NextTokenstring

下一个查询开始的Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopGroupsarray

桌面组列表。

object

桌面组信息。

CreateTimestring

创建时间。

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

付费类型。

PrePaid
PolicyGroupNamestring

策略名称。

test-policy
Creatorstring

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

1007214305******
MaxDesktopsCountinteger

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

10
SystemDiskSizeinteger

系统盘容量。单位为GiB。

80
PolicyGroupIdstring

策略ID。

pg-53iyi2aar0nd6c8qj
OwnBundleIdstring

桌面模板ID。

bundle_eds_general_4c8g_s8d5_win2019
GpuCountnumber

GPU核数。

1
Memorylong

内存大小。单位为MiB。

16384
GpuSpecstring

GPU显存。

16 GiB
OwnBundleNamestring

桌面模板名称。

test
DataDiskCategorystring

数据盘类型。

cloud_ssd
DesktopGroupNamestring

桌面组名称。

test1
SystemDiskCategorystring

系统盘类型。

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账号。

SIMPLE
Statusinteger

桌面组状态。

1
ResetTypelong

桌面重置类型。

0
LoadPolicylong

多会话桌面组负载策略。

1
BindAmountlong

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

1
OwnTypelong

桌面组类型。

0
ImageIdstring

镜像ID。

m-gq15cq5ydlvwn****
VolumeEncryptionEnabledboolean

是否开启加密功能。

false
VolumeEncryptionKeystring

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

e5409ada-xxxx-xxxx-xxxx-89e31e23e993
RatioThresholdnumber
ConnectDurationlong
IdleDisconnectDurationlong
Versioninteger
StopDurationlong

示例

正常返回示例

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": true,
      "VolumeEncryptionKey": "e5409ada-xxxx-xxxx-xxxx-89e31e23e993",
      "RatioThreshold": 0,
      "ConnectDuration": 0,
      "IdleDisconnectDuration": 0,
      "Version": 0,
      "StopDuration": 0
    }
  ]
}

错误码

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

变更历史

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