首页 无影云桌面 API参考(云桌面管控) API目录 桌面组 GetDesktopGroupDetail - 获取桌面组详情

GetDesktopGroupDetail - 获取桌面组详情

获取某一个桌面组的详细信息。

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
DesktopGroupIdstring

桌面组ID。

dg-2i8qxpv6t1a03****

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求ID。

1B5268CE-5EB3-545F-9F38-A8BCF7105777
Desktopsobject

桌面组信息。

Statusinteger

桌面组状态。

1
CreationTimestring

创建时间。

2020-11-06T08:28Z
PayTypestring

付费类型。

PrePaid
ResetTypeinteger

重置类型。

0
LoadPolicyinteger

多会话桌面组负载策略。

0
PolicyGroupNamestring

安全策略组名称。

test
Creatorstring

创建者。

15517733537*****
MaxDesktopsCountinteger

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

10
AllowAutoSetupinteger

是否允许自动扩容。

1
ResTypeinteger

资源类型。

0
SystemDiskSizeinteger

系统盘大小。

80
PolicyGroupIdstring

安全策略组ID。

pg-9cktlowtxfl6****
OwnBundleIdstring

模版ID。

b-1se9fb37r5tfq****
GpuCountnumber

GPU核数。

4
AllowBufferCountinteger

允许预留的空闲桌面数。

1
Memorylong

内存大小。

4096
GpuSpecstring

GPU规格。

NVIDIA T4
DirectoryIdstring

目录ID(工作区ID)。

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

模版名称。

BundleDemo
DataDiskCategorystring

数据盘类型。

cloud_essd
DesktopGroupNamestring

桌面组名称。

DesktopGroupDemo
BindAmountinteger

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

1
OwnTypeinteger

桌面组类型。

0
SystemDiskCategorystring

系统盘类型。

cloud_essd
OfficeSiteIdstring

工作区ID。

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

断连保留时长(单位:ms)。

180000
MinDesktopsCountinteger

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

1
DataDiskSizestring

数据盘大小。

80
DesktopGroupIdstring

桌面组ID。

dg-3uiojcc0j4kh7****
OfficeSiteNamestring

工作区名称。

test
DirectoryTypestring

目录类型。

SIMPLE
Cpuinteger

CPU核数。

4
ExpiredTimestring

到期时间。

2021-12-31T15:59Z
Commentsstring

桌面组备注。

for students
OfficeSiteTypestring

工作区类型。

SIMPLE
TimerInfosarray

定时时间列表。

object

定时时间。

Statusinteger

状态。

1
CronExpressionstring

Cron表达式。

0 58 11 ? * 2
TimerTypeinteger

定时任务类型。

1
Forcedboolean
RatioThresholdnumber
ConnectDurationlong
IdleDisconnectDurationlong
Versionlong
StopDurationlong
ProfileFollowSwitchboolean
NasFileSystemIDstring
NasFileSystemNamestring
TimingStrategyInfostring
ScaleTimerInfosarray
object
Typestring
Cronstring
LoadPolicyinteger
MinResAmountinteger
KeepDurationlong
RatioThresholdnumber
PolicyGroupIdsarray
string
PolicyGroupNamesarray
string

示例

正常返回示例

JSON格式

{
  "RequestId": "1B5268CE-5EB3-545F-9F38-A8BCF7105777",
  "Desktops": {
    "Status": 1,
    "CreationTime": "2020-11-06T08:28Z",
    "PayType": "PrePaid",
    "ResetType": 0,
    "LoadPolicy": 0,
    "PolicyGroupName": "test",
    "Creator": "15517733537*****",
    "MaxDesktopsCount": 10,
    "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": "DesktopGroupDemo",
    "BindAmount": 1,
    "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": "for students",
    "OfficeSiteType": "SIMPLE",
    "TimerInfos": [
      {
        "Status": 1,
        "CronExpression": "0 58 11 ? * 2",
        "TimerType": 1,
        "Forced": true
      }
    ],
    "RatioThreshold": 0,
    "ConnectDuration": 0,
    "IdleDisconnectDuration": 0,
    "Version": 0,
    "StopDuration": 0,
    "ProfileFollowSwitch": true,
    "NasFileSystemID": "",
    "NasFileSystemName": "",
    "TimingStrategyInfo": "",
    "ScaleTimerInfos": [
      {
        "Type": "",
        "Cron": "",
        "LoadPolicy": 0,
        "MinResAmount": 0,
        "KeepDuration": 0,
        "RatioThreshold": 0
      }
    ],
    "PolicyGroupIds": [
      ""
    ],
    "PolicyGroupNames": [
      ""
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2021-11-04OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 无影云桌面 相关技术圈