获取一个共享型云电脑的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:GetDesktopGroupDetail |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。 |
cn-hangzhou |
| DesktopGroupId |
string |
是 |
共享型云电脑 ID。 |
dg-2i8qxpv6t1a03**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回信息集合。 |
||
| RequestId |
string |
请求 ID。 |
1B5268CE-5EB3-545F-9F38-A8BCF710**** |
| Desktops |
object |
共享型云电脑信息。 |
|
| Status |
integer |
共享型云电脑的状态。 枚举值：
|
1 |
| CreationTime |
string |
创建时间。时间格式为 ISO 8601 标准（UTC 时间）。 |
2020-11-06T08:28Z |
| PayType |
string |
付费类型。 枚举值：
|
PrePaid |
| ResetType |
integer |
云电脑重置类型。 枚举值：
|
0 |
| LoadPolicy |
integer |
多会话多台共享型云电脑的负载均衡策略。 枚举值：
|
0 |
| PolicyGroupName |
string |
共享型云电脑关联的策略名称。 |
All enabled policy |
| Creator |
string |
创建者的阿里云账号 ID。 |
155177335370**** |
| MaxDesktopsCount |
integer |
|
3 |
| AllowAutoSetup |
integer |
是否允许包年包月共享型云电脑自动创建云电脑。 枚举值：
|
1 |
| ResType |
integer |
资源类型，目前仅支持 ECS。 枚举值：
|
0 |
| SystemDiskSize |
integer |
系统盘容量。单位为 GiB。 |
80 |
| PolicyGroupId |
string |
共享型云电脑关联的策略 ID。 |
pg-9cktlowtxfl6**** |
| OwnBundleId |
string |
云电脑模板 ID。 |
b-1se9fb37r5tfq**** |
| GpuCount |
number |
GPU 核数。 |
4 |
| AllowBufferCount |
integer |
该参数仅适用于按量付费的共享型云电脑，表示始终预留为已开机且空闲待连接状态的云电脑数量。取值范围：
|
1 |
| Memory |
integer |
内存大小。单位为 MiB。 |
4096 |
| GpuSpec |
string |
GPU 规格。 |
NVIDIA T4 |
| DirectoryId |
string |
目录 ID（办公网络 ID）。 |
cn-hangzhou+dir-363353**** |
| OwnBundleName |
string |
云电脑模板名称。 |
BundleDemo |
| DataDiskCategory |
string |
用户磁盘类型。 |
cloud_essd |
| DesktopGroupName |
string |
要查询的共享型云电脑名称。 |
CloudComputerPool01 |
| BindAmount |
integer |
多会话多台共享型云电脑中每台云电脑允许的并发会话数。 |
2 |
| OwnType |
integer |
共享型云电脑类型。 枚举值：
|
0 |
| SystemDiskCategory |
string |
系统盘类型。 |
cloud_essd |
| OfficeSiteId |
string |
办公网络 ID。 |
cn-hangzhou+dir-990541**** |
| KeepDuration |
integer |
会话断开连接后继续保留的时间。单位为毫秒，取值范围为 180000（3 分钟）~345600000（4 天）。取值为 0 时，表示始终保留。 当会话因为用户主动断开或因为其他因素意外断开时，从断开的时刻开始计算，若在该保留时长内用户始终未重新建立与该会话的连接，则该会话注销，未保存的数据都将销毁；若在该保留时长内，用户重新建立连接成功，则仍可进入原来的会话，仍可访问对话断开之前的数据。 |
180000 |
| MinDesktopsCount |
integer |
|
1 |
| DataDiskSize |
string |
用户磁盘容量。单位为 GiB。 |
80 |
| DesktopGroupId |
string |
共享型云电脑 ID。 |
dg-3uiojcc0j4kh7**** |
| OfficeSiteName |
string |
共享型云电脑所属的办公网络名称。 |
研发部办公网络 |
| DirectoryType |
string |
目录类型。 |
SIMPLE |
| Cpu |
integer |
vCPU 核数。 |
4 |
| Comments |
string |
备注信息。 |
comment |
| OfficeSiteType |
string |
办公网络的账号体系类型。 枚举值：
|
SIMPLE |
| TimerInfos |
array<object> |
定时时间列表。 |
|
|
object |
定时时间。 |
||
| Status |
integer |
状态。 枚举值：
|
1 |
| CronExpression |
string |
Cron 表达式。 |
0 58 11 ? * 2 |
| TimerType |
integer |
定时任务类型。 枚举值：
|
1 |
| Forced |
boolean |
是否强制执行该定时任务。 |
false |
| RatioThreshold |
number |
会话占用率阈值，用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为：
当会话占用率达到该阈值时，则会新建云电脑；未达到该阈值时，则删除多余的云电脑。 |
0.85 |
| ConnectDuration |
integer |
会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位：毫秒。 |
3600000 |
| IdleDisconnectDuration |
integer |
用户会话建立连接后，如果在该最大时长内，始终没有任何键盘或鼠标操作，则该会话断开连接。单位：毫秒。 |
900000 |
| Version |
integer |
共享型云电脑版本号。 |
2 |
| StopDuration |
integer |
空闲关机时间。当云电脑空闲时长达到该值时，自动关机。关机后如果有用户连接，会自动开机。单位：毫秒。 |
180000 |
| ProfileFollowSwitch |
boolean |
是否开启用户数据漫游。 |
false |
| NasFileSystemID |
string |
用户数据漫游功能使用的 NAS 文件系统 ID。 |
0783b4**** |
| NasFileSystemName |
string |
用户数据漫游功能使用的 NAS 文件系统名称。 |
abcd |
| TimingStrategyInfo |
string |
定时应用信息。 |
abcd |
| ScaleTimerInfos |
array<object> |
定时任务信息。 |
|
|
object |
定时任务信息。 |
||
| Type |
string |
定时任务类型。 枚举值：
|
rise |
| Cron |
string |
定时任务的 Cron 表达式。 |
0 0 0 * * ? |
| LoadPolicy |
integer |
多会话多台共享型云电脑的负载均衡策略。 枚举值：
|
1 |
| BuyResAmount |
integer |
伸缩策略参数之一：购买云电脑数。取值范围：0~200。 |
5 |
| MinResAmount |
integer |
伸缩策略参数之一：云电脑最小数量。取值范围：0~200。 |
1 |
| MaxResAmount |
integer |
伸缩策略参数之一：云电脑最大数量。取值范围：0~200。 |
100 |
| KeepDuration |
integer |
会话断开连接后继续保留的时间。单位为毫秒，取值范围为 180000（3 分钟）~345600000（4 天）。取值为 0 时，表示始终保留。 当会话因为用户主动断开或因为其他因素意外断开时，从断开的时刻开始计算，若在该保留时长内用户始终未重新建立与该会话的连接，则该会话注销，未保存的数据都将销毁；若在该保留时长内，用户重新建立连接成功，则仍可进入原来的会话，仍可访问对话断开之前的数据。 |
180000 |
| RatioThreshold |
number |
会话占用率阈值，用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为：
当会话占用率达到该阈值时，则会新建云电脑；未达到该阈值时，则删除多余的云电脑。 |
0.85 |
| PolicyGroupIds |
array |
共享型云电脑关联的策略 ID 列表。 |
|
|
string |
共享型云电脑关联的策略 ID。 |
pd-abcd*** |
|
| PolicyGroupNames |
array |
共享型云电脑关联的策略名称列表。 |
|
|
string |
共享型云电脑关联的策略名称。 |
All enabled policy |
|
| BuyDesktopsCount |
integer |
该参数仅适用于包年包月的共享型云电脑，表示初始购买的云电脑数量。取值范围：0~200。 |
5 |
| ImageId |
string |
镜像 ID。 |
m-4zfb6zj728hhr**** |
| ExpiredTime |
string |
包年包月共享型云电脑的到期时间。时间格式为 ISO 8601 标准（UTC 时间）。 |
2021-12-31T15:59Z |
| OsType |
string |
云电脑的操作系统类型。 |
Windows |
| ProtocolType |
string |
协议类型。 |
ASP |
| ExpiredTimes |
array |
到期时间列表。 |
|
|
string |
到期时间列表。时间格式为 ISO 8601 标准（UTC 时间）。 |
2024-06-30T16:00Z |
|
| EnvType |
string |
环境类型，不对外开放。 |
Private |
| EnvId |
string |
环境 ID，不对外开放。 |
adifa**** |
示例
正常返回示例
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": "研发部办公网络",
"DirectoryType": "SIMPLE",
"Cpu": 4,
"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****",
"ExpiredTime": "2021-12-31T15:59Z",
"OsType": "Windows",
"ProtocolType": "ASP",
"ExpiredTimes": [
"2024-06-30T16:00Z"
],
"EnvType": "Private",
"EnvId": "adifa****"
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。