文档

DescribeDesktopGroups - 查询云电脑池列表及详情

更新时间:

查询云电脑池列表及详情。

调试

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

授权信息

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

请求参数

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

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
OfficeSiteIdstring

云电脑池所属的办公网络 ID。

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

要查询的云电脑池名称,支持模糊查询。

CloudComputerPool01
DesktopGroupIdstring

云电脑池 ID。

dg-2i8qxpv6t1a03****
Periodinteger

包年包月云电脑池的购买时长。单位由PeriodUnit指定。

  • 如果PeriodUnitMonth,该参数的取值范围:
    • 1
    • 2
    • 3
    • 6
  • 如果PeriodUnitYear,该参数的取值范围:
    • 1
    • 2
    • 3
    • 4
    • 5
1
PeriodUnitstring

包年包月计费方式的时长单位。

Month
MaxResultsinteger

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

10
NextTokenstring

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

caeba0bbb2be03f84eb48b699f0a4883
PolicyGroupIdstring

云电脑池关联的策略 ID。

pg-53iyi2aar0nd6****
Statusinteger

云电脑池的状态。

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

云电脑池类型。

说明 该参数暂未开放使用。
枚举值:
  • 0个人型云电脑池(单会话)
  • 1共享型云电脑池(多会话)
0
EndUserIdsarray

云电脑池的授权用户 ID 列表。

string

云电脑池的授权用户 ID。

alice
ExcludedEndUserIdsarray

要排除的已授权用户列表。

string

要排除的已授权用户。

Tony
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
ImageIdarray

镜像 ID 列表。

string

镜像 ID。

m-eeuo9qab4b0****
BundleIdarray

云电脑模板 ID 列表。

string

云电脑模板 ID。

b-4w5nk44znm6****
Tagobject []

标签列表。可包含 1~20 个。

Keystring

标签键。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestKey
Valuestring

标签值。可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

TestValue

返回参数

名称类型描述示例值
object

返回信息集合。

NextTokenstring

下一个查询开始的 Token。

caeba0bbb2be03f84eb48b699f0a4883
RequestIdstring

请求 ID。

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

云电脑池列表。

CreateTimestring

创建时间。

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

付费类型。

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

云电脑池关联的策略名称。

All enabled policy
Creatorstring

创建者的阿里云账号 ID。

1007214305******
MaxDesktopsCountinteger

按量付费云电脑池内能容纳的云电脑最大数量。

3
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_ssdSSD云盘
  • cloud_essdESSD云盘
cloud_ssd
DesktopGroupNamestring

云电脑池名称。

CloudComputerPool01
SystemDiskCategorystring

系统盘类型。

枚举值:
  • cloud_efficiency高效云盘
  • cloud_ssdSSD云盘
  • cloud_essdESSD云盘
cloud_ssd
OfficeSiteIdstring

云电脑池所属的办公网络名称。

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

会话断开连接后继续保留的时间。单位为毫秒,取值范围为 180000(3 分钟)~345600000(4 天)。取值为 0 时,表示始终保留。

当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。

180000
MinDesktopsCountinteger

包年包月云电脑池内自动创建云电脑的上限。

1
EndUserCountinteger

云电脑池的授权用户数。

1
DataDiskSizestring

用户磁盘容量。单位为 GiB。

50
DesktopGroupIdstring

云电脑池 ID。

dg-2i8qxpv6t1a03****
OfficeSiteNamestring

云电脑池所属的办公网络 ID。

cn-hangzhou+os-c5cy7q578s8jc****
Cpuinteger

vCPU 核数。

4
ExpiredTimestring

包年包月云电脑池的到期时间。

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

备注信息。

comment
OfficeSiteTypestring

办公网络的账号体系类型。

枚举值:
  • PERSONAL个人型办公网络
  • SIMPLE便捷办公网络
  • AD_CONNECTORAD办公网络
  • RAMRAM型办公网络
SIMPLE
Statusinteger

云电脑池的状态。

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

云电脑池重置类型。

枚举值:
  • 0不重置
  • 1只重置系统盘
  • 2只重置用户磁盘
  • 3重置系统盘和用户磁盘
0
LoadPolicylong

多会话云电脑池的负载均衡策略。

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

多会话云电脑池中每台云电脑允许的并发会话数。

2
OwnTypelong

云电脑池类型。

枚举值:
  • 0个人型云电脑池(单会话)
  • 1共享型云电脑池(多会话)
0
ImageIdstring

镜像 ID。

m-gq15cq5ydlvwn****
VolumeEncryptionEnabledboolean

是否开启加密功能。

false
VolumeEncryptionKeystring

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

e5409ada-xxxx-xxxx-xxxx-89e31e23e993
RatioThresholdfloat

会话占用率阈值,用作多会话云电脑池的自动伸缩触发条件。会话占用率的计算公式为:

会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%

当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。

0.85
ConnectDurationlong

会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。

3600000
IdleDisconnectDurationlong

用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。

90000
Versioninteger

云电脑池版本号。

2
StopDurationlong

空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。

900000
ProtocolTypestring

协议类型。

枚举值:
  • HDXHDX协议
  • ASP阿里云自研ASP协议
ASP
OsTypestring

操作系统类型。

枚举值:
  • LinuxLinux
  • WindowsWindows
Windows
BuyDesktopsCountinteger
  • 对于包年包月云电脑池:购买云电脑数量。取值范围:0~200。
  • 对于按量付费云电脑池:池内云电脑最小创建数量。默认值为 1,取值范围为 0~MaxDesktopsCount
5
DesktopCountinteger

已创建的云电脑数量。

2
DesktopTypestring

目标云电脑规格。您可以调用 DescribeDesktopTypes 查询无影云电脑支持的规格 ID。

eds.enterprise_office.4c4g
CountPerStatusobject []

每种状态下的云电脑数量列表。

Statusstring

云电脑状态。

枚举值:
  • Stopped已关机
  • Starting启动中
  • Rebuilding重建中
  • Running运行中
  • Stopping停止中
  • Expired已过期
  • Deleted已删除
  • Pending等待中
Running
Countinteger

云电脑数量。

10
GpuDriverVersionstring

GPU 驱动版本。

12
SubnetIdstring

子网 ID。

vsw-uf63bb6*****8gfytm
Tagsobject []

标签列表

Keystring

标签键。

desktop_group_name
Valuestring

标签值。

ds-dq2mybjr23yw*****

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-06-14OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Tag
出参OpenAPI 返回结构发生变更
2023-08-01OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-17OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ImageId
    新增入参:BundleId
2021-11-04OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:EndUserIds
    新增入参:ExcludedEndUserIds
  • 本页导读 (0)