文档

GetDesktopGroupDetail - 获取云电脑池详情

更新时间:

获取一个云电脑池的详细信息。

调试

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

授权信息

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

请求参数

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

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

cn-hangzhou
DesktopGroupIdstring

云电脑池 ID。

dg-2i8qxpv6t1a03****

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1B5268CE-5EB3-545F-9F38-A8BCF710****
Desktopsobject

云电脑池信息。

Statusinteger

云电脑池的状态。

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

创建时间。

2020-11-06T08:28Z
PayTypestring

付费类型。

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

云电脑重置类型。

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

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

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

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

All enabled policy
Creatorstring

创建者的阿里云账号 ID。

155177335370****
MaxDesktopsCountinteger

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

3
AllowAutoSetupinteger

是否允许包年包月云电脑池自动创建云电脑。

枚举值:
  • 0不允许
  • 1允许
1
ResTypeinteger

资源类型,目前仅支持 ECS。

0
SystemDiskSizeinteger

系统盘容量。单位为 GiB。

80
PolicyGroupIdstring

云电脑池关联的策略 ID。

pg-9cktlowtxfl6****
OwnBundleIdstring

云电脑模板 ID。

b-1se9fb37r5tfq****
GpuCountfloat

GPU 核数。

4
AllowBufferCountinteger

按量付费云电脑池内允许预留的云电脑数量。取值范围:

  • 0:不预留
  • N:预留 N 台(1≤N≤100)
1
Memorylong

内存大小。单位为 MiB。

4096
GpuSpecstring

GPU 规格。

NVIDIA T4
DirectoryIdstring

目录 ID(办公网络 ID)。

cn-hangzhou+dir-363353****
OwnBundleNamestring

云电脑模板名称。

BundleDemo
DataDiskCategorystring

用户磁盘类型。

cloud_essd
DesktopGroupNamestring

要查询的云电脑池名称。

CloudComputerPool01
BindAmountinteger

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

2
OwnTypeinteger

云电脑池类型。

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

系统盘类型。

cloud_essd
OfficeSiteIdstring

办公网络 ID。

cn-hangzhou+dir-990541****
KeepDurationlong

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

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

180000
MinDesktopsCountinteger

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

1
DataDiskSizestring

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

80
DesktopGroupIdstring

云电脑池 ID。

dg-3uiojcc0j4kh7****
OfficeSiteNamestring

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

test
DirectoryTypestring

目录类型。

SIMPLE
Cpuinteger

vCPU 核数。

4
ExpiredTimestring

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

2021-12-31T15:59Z
Commentsstring

备注信息。

comment
OfficeSiteTypestring

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

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

定时时间列表。

Statusinteger

状态。

枚举值:
  • 1启用
  • 2禁用
  • 3删除
1
CronExpressionstring

Cron 表达式。

0 58 11 ? * 2
TimerTypeinteger

定时任务类型。

枚举值:
  • 1定时重置
  • 2定时开机
  • 3定时关机
  • 4定时重启
1
Forcedboolean

是否强制执行该定时任务。

false
RatioThresholdfloat

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

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

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

0.85
ConnectDurationlong

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

3600000
IdleDisconnectDurationlong

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

900000
Versionlong

云电脑池版本号。

2
StopDurationlong

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

180000
ProfileFollowSwitchboolean

是否开启用户数据漫游。

false
NasFileSystemIDstring

用户数据漫游功能使用的 NAS 文件系统 ID。

0783b4****
NasFileSystemNamestring

用户数据漫游功能使用的 NAS 文件系统名称。

abcd
TimingStrategyInfostring

定时应用信息。

abcd
ScaleTimerInfosobject []

定时任务信息。

Typestring

定时任务类型。

枚举值:
  • drop下降策略
  • normal正常策略
  • peak高峰策略
  • rise上升策略
rise
Cronstring

定时任务的 Cron 表达式。

0 0 0 * * ?
LoadPolicyinteger

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

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

伸缩策略参数之一:购买云电脑数。取值范围:0~200。

5
MinResAmountinteger

伸缩策略参数之一:云电脑最小数量。取值范围:0~200。

1
MaxResAmountinteger

伸缩策略参数之一:云电脑最大数量。取值范围:0~200。

100
KeepDurationlong

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

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

180000
RatioThresholdfloat

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

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

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

0.85
PolicyGroupIdsarray

云电脑池关联的策略 ID 列表。

string

云电脑池关联的策略 ID。

pd-abcd***
PolicyGroupNamesarray

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

string

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

All enabled policy
BuyDesktopsCountinteger
  • 对于包年包月云电脑池:购买云电脑数量。取值范围:0~200。
  • 对于按量付费云电脑池:池内云电脑最小创建数量。默认值为 1,取值范围为 0~MaxDesktopsCount
5
ImageIdstring

镜像 ID。

m-4zfb6zj728hhr****

示例

正常返回示例

JSON格式

{
  "RequestId": "1B5268CE-5EB3-545F-9F38-A8BCF710****",
  "Desktops": {
    "Status": 1,
    "CreationTime": "2020-11-06T08:28Z",
    "PayType": "PrePaid",
    "ResetType": 0,
    "LoadPolicy": 0,
    "PolicyGroupName": "All enabled policy",
    "Creator": "155177335370****",
    "MaxDesktopsCount": 3,
    "AllowAutoSetup": 1,
    "ResType": 0,
    "SystemDiskSize": 80,
    "PolicyGroupId": "pg-9cktlowtxfl6****",
    "OwnBundleId": "b-1se9fb37r5tfq****",
    "GpuCount": 4,
    "AllowBufferCount": 1,
    "Memory": 4096,
    "GpuSpec": "NVIDIA T4",
    "DirectoryId": "cn-hangzhou+dir-363353****",
    "OwnBundleName": "BundleDemo",
    "DataDiskCategory": "cloud_essd",
    "DesktopGroupName": "CloudComputerPool01\n",
    "BindAmount": 2,
    "OwnType": 0,
    "SystemDiskCategory": "cloud_essd",
    "OfficeSiteId": "cn-hangzhou+dir-990541****",
    "KeepDuration": 180000,
    "MinDesktopsCount": 1,
    "DataDiskSize": "80",
    "DesktopGroupId": "dg-3uiojcc0j4kh7****",
    "OfficeSiteName": "test",
    "DirectoryType": "SIMPLE",
    "Cpu": 4,
    "ExpiredTime": "2021-12-31T15:59Z",
    "Comments": "comment",
    "OfficeSiteType": "SIMPLE",
    "TimerInfos": [
      {
        "Status": 1,
        "CronExpression": "0 58 11 ? * 2",
        "TimerType": 1,
        "Forced": false
      }
    ],
    "RatioThreshold": 0.85,
    "ConnectDuration": 3600000,
    "IdleDisconnectDuration": 900000,
    "Version": 2,
    "StopDuration": 180000,
    "ProfileFollowSwitch": false,
    "NasFileSystemID": "0783b4****",
    "NasFileSystemName": "abcd",
    "TimingStrategyInfo": "abcd",
    "ScaleTimerInfos": [
      {
        "Type": "rise",
        "Cron": "0 0 0 * * ? ",
        "LoadPolicy": 1,
        "BuyResAmount": 5,
        "MinResAmount": 1,
        "MaxResAmount": 100,
        "KeepDuration": 180000,
        "RatioThreshold": 0.85
      }
    ],
    "PolicyGroupIds": [
      "pd-abcd***"
    ],
    "PolicyGroupNames": [
      "All enabled policy"
    ],
    "BuyDesktopsCount": 5,
    "ImageId": "m-4zfb6zj728hhr****"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈