DescribeDesktopGroups查询共享型云电脑列表-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

查询共享型云电脑列表及详情。

调试

您可以在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	否	包年包月共享型云电脑的购买时长。单位由`PeriodUnit`指定。如果`PeriodUnit`为`Month`，该参数的取值范围： 1 2 3 6 如果`PeriodUnit`为`Year`，该参数的取值范围： 1 2 3 4 5	1
PeriodUnit	string	否	包年包月计费方式的时长单位。枚举值： Month : 月 Year : 年	Month
MaxResults	integer	否	分页查询时每页行数。最大值：100。默认值：10。	10
NextToken	string	否	下一个查询开始的 Token，NextToken 为空表示没有下一个。	caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupId	string	否	共享型云电脑关联的策略 ID。	pg-53iyi2aar0nd6****
Status	integer	否	共享型云电脑的状态。枚举值： 0 : 未支付 1 : 正常 2 : 欠费或过期	1
OwnType	integer	否	共享型云电脑类型。说明该参数暂未开放使用。枚举值： 0 : 单会话多台共享型云电脑 1 : 多会话多台共享型云电脑	0
EndUserIds	array	否	共享型云电脑的授权用户 ID 列表。
	string	否	共享型云电脑的授权用户 ID。	alice
ExcludedEndUserIds	array	否	要排除的已授权用户列表。
	string	否	要排除的已授权用户。	Tony
ProtocolType	string	否	协议类型。枚举值： HDX : HDX 协议 ASP : 阿里云自研 ASP 协议	ASP
ImageId	array	否	镜像 ID 列表。
	string	否	镜像 ID。	m-eeuo9qab4b0****
BundleId	array	否	云电脑模板 ID 列表。
	string	否	云电脑模板 ID。	b-4w5nk44znm6****
Tag	array<object>	否	标签列表。可包含 1~20 个。
	object	否	标签。
Key	string	否	标签键。一旦传入该值，则不允许为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	TestKey
Value	string	否	标签值。可以为空字符串。最多支持 128 个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。	TestValue
MultiResource	boolean	否	是否为多台共享类型的共享型云电脑。枚举值： true : 多台共享型云电脑 false : 单台共享型云电脑	true
DesktopGroupIds	array	否	共享型云电脑 ID 列表。
	string	否	共享型云电脑 ID。	dg-2i8qxpv6t1a03****
DesktopType	string	否
QosRuleId	string	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
NextToken	string	下一个查询开始的 Token。	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
DesktopGroups	array<object>	共享型云电脑列表。
	array<object>	共享型云电脑信息。
CreateTime	string	创建时间。	2022-02-17T14:51:07Z
PayType	string	付费类型。枚举值： PostPaid : 按量付费 PrePaid : 包年包月	PrePaid
PolicyGroupName	string	共享型云电脑关联的策略名称。	All enabled policy
Creator	string	创建者的阿里云账号 ID。	1007214305******
MaxDesktopsCount	integer	对于按量付费的共享型云电脑，该参数表示云电脑的最大创建数量。对于包年包月的共享型云电脑，该参数表示初始购买的云电脑数量（`BuyDesktopsCount`）与允许自动创建的云电脑数量之和。	3
SystemDiskSize	integer	系统盘容量。单位为 GiB。	80
PolicyGroupId	string	共享型云电脑关联的策略 ID。	pg-53iyi2aar0nd6c8qj
OwnBundleId	string	云电脑模板 ID。	bundle_eds_general_4c8g_s8d5_win2019
GpuCount	number	GPU 核数。	1
Memory	integer	内存大小。单位为 MiB。	16384
GpuSpec	string	GPU 显存。	16 GiB
OwnBundleName	string	云电脑模板名称。	test
DataDiskCategory	string	用户磁盘类型。枚举值： cloud_efficiency : 高效云盘 cloud_ssd : SSD 云盘 cloud_essd : ESSD 云盘	cloud_ssd
DesktopGroupName	string	共享型云电脑名称。	CloudComputerPool01
SystemDiskCategory	string	系统盘类型。枚举值： cloud_efficiency : 高效云盘 cloud_ssd : SSD 云盘 cloud_essd : ESSD 云盘	cloud_ssd
OfficeSiteId	string	共享型云电脑所属的办公网络名称。	cn-hangzhou+dir-467671****
KeepDuration	integer	会话断开连接后继续保留的时间。单位为毫秒，取值范围为 180000（3 分钟）~345600000（4 天）。取值为 0 时，表示始终保留。当会话因为用户主动断开或因为其他因素意外断开时，从断开的时刻开始计算，若在该保留时长内用户始终未重新建立与该会话的连接，则该会话注销，未保存的数据都将销毁；若在该保留时长内，用户重新建立连接成功，则仍可进入原来的会话，仍可访问对话断开之前的数据。	180000
MinDesktopsCount	integer	对于按量付费的共享型云电脑，该参数表示云电脑的最小创建数量。对于包年包月的共享型云电脑，该参数等同于`BuyDesktopsCount`，表示初始购买的云电脑数量。	1
EndUserCount	integer	共享型云电脑的授权用户数。	1
DataDiskSize	string	用户磁盘容量。单位为 GiB。	50
DesktopGroupId	string	共享型云电脑 ID。	dg-2i8qxpv6t1a03****
OfficeSiteName	string	共享型云电脑所属的办公网络 ID。	cn-hangzhou+os-c5cy7q578s8jc****
Cpu	integer	vCPU 核数。	4
ExpiredTime	string	包年包月共享型云电脑的到期时间。	2022-03-17T16:00:00Z
Comments	string	备注信息。	comment
OfficeSiteType	string	办公网络的账号体系类型。枚举值： PERSONAL : 个人型办公网络 SIMPLE : 便捷办公网络 AD_CONNECTOR : AD 办公网络 RAM : RAM 型办公网络	SIMPLE
Status	integer	共享型云电脑的状态。枚举值： 0 : 未支付 1 : 正常 2 : 欠费或过期	1
ResetType	integer	共享型云电脑重置类型。枚举值： 0 : 不重置 1 : 只重置系统盘 2 : 只重置用户磁盘 3 : 重置系统盘和用户磁盘	0
LoadPolicy	integer	多会话多台共享型云电脑的负载均衡策略。枚举值： 0 : 深度优先 1 : 广度优先	1
BindAmount	integer	多会话多台共享型云电脑中每台云电脑允许的并发会话数。	2
OwnType	integer	共享型云电脑类型。枚举值： 0 : 单会话多台共享型云电脑 1 : 多会话多台共享型云电脑	0
ImageId	string	镜像 ID。	m-gq15cq5ydlvwn****
VolumeEncryptionEnabled	boolean	是否开启加密功能。	false
VolumeEncryptionKey	string	加密磁盘使用的 KMS 密钥 ID。	e5409ada-xxxx-xxxx-xxxx-89e31e23e993
RatioThreshold	number	会话占用率阈值，用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为： `会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%` 当会话占用率达到该阈值时，则会新建云电脑；未达到该阈值时，则删除多余的云电脑。	0.85
ConnectDuration	integer	会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位：毫秒。	3600000
IdleDisconnectDuration	integer	用户会话建立连接后，如果在该最大时长内，始终没有任何键盘或鼠标操作，则该会话断开连接。单位：毫秒。	90000
Version	integer	共享型云电脑版本号。	2
StopDuration	integer	空闲关机时间。当云电脑空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。	900000
ProtocolType	string	协议类型。枚举值： HDX : HDX 协议 ASP : 阿里云自研 ASP 协议	ASP
OsType	string	操作系统类型。枚举值： Linux : Linux Windows : Windows	Windows
BuyDesktopsCount	integer	该参数仅适用于包年包月的共享型云电脑，表示初始购买的云电脑数量。取值范围：0~200。	5
DesktopCount	integer	已创建的云电脑数量。	2
DesktopType	string	目标云电脑规格。您可以调用 DescribeDesktopTypes 查询无影云电脑支持的规格 ID。	eds.enterprise_office.4c4g
CountPerStatus	array<object>	每种状态下的云电脑数量列表。
	object	每种状态下的云电脑数量。
Status	string	云电脑状态。枚举值： Stopped : 已关机 Starting : 启动中 Rebuilding : 重建中 Running : 运行中 Stopping : 停止中 Expired : 已过期 Deleted : 已删除 Pending : 等待中	Running
Count	integer	云电脑数量。	10
GpuDriverVersion	string	GPU 驱动版本。	12
SubnetId	string	子网 ID。	vsw-uf63bb6*****8gfytm
Tags	array<object>	标签列表
	object	标签信息。
Key	string	标签键。	desktop_group_name
Value	string	标签值。	ds-dq2mybjr23yw*****
UserOuPath	string	用户组织单元路径。	example.com
IsLdap	boolean
UserGroupName	string
PolicyGroupIdList	array
	string
PolicyGroupNameList	array
	string
SimpleUserGroupId	string
AccountType	string
EntraDomainName	string
ExpiredTimes	array
	string
EnvType	string
EnvId	string
QosRuleId	string

示例

正常返回示例

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",
      "IsLdap": true,
      "UserGroupName": "",
      "PolicyGroupIdList": [
        ""
      ],
      "PolicyGroupNameList": [
        ""
      ],
      "SimpleUserGroupId": "",
      "AccountType": "",
      "EntraDomainName": "",
      "ExpiredTimes": [
        ""
      ],
      "EnvType": "",
      "EnvId": "",
      "QosRuleId": ""
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。