- 最新动态
- 服务公告
- 功能总览
- 产品介绍
- 快速入门
- 用户指南(终端用户)
- 用户指南(管理员)
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
- 应用示例
-
云桌面API
- 云办公服务
- 租户配置
-
桌面
- 创建桌面
- 查询桌面列表
- 修改桌面属性
- 删除单个桌面
- 查询单个桌面详情
- 批量删除桌面
- 批量注销桌面
- 查询桌面详情列表
- 操作桌面
- 变更规格
- 重建桌面
- 查询桌面开关机信息
- 查询桌面监控信息
- 远程登录控制台
- 更新桌面SID
- 重新加入AD域
- 桌面转镜像
- 批量解绑用户
- 解绑用户
- 分配用户
- 批量修改用户权限组
- 查询桌面网络
- 切换桌面网络
- 批量查询桌面网络
- 批量切换桌面网络
- 查询sysprep版本信息
- 批量设置桌面维护模式
- 预批量分配用户
- 批量分配用户
- AD场景支持桌面更换关联用户名
- 发送消息通知
- 查询桌面安装agent详情
- 安装agent
- 根据桌面id查询远程协助信息
- 创建远程协助
- 取消远程协助
- 查询桌面连接状态列表
- 根据子网id查询该子网下可用的ip
- 桌面池
- 桌面名称策略
- 桌面标签
- 协同桌面
- 用户
- 用户组
- 组织单元
- 磁盘
- 快照
- 连接信息
- 策略组
- 终端与桌面绑定
- 订单
- 询价
- 产品套餐
- 定时任务
- 报表统计
- 告警
- 用户操作日志
- 脚本
- 配额
- 镜像
- 可用分区
- 任务
- 网络
- 委托
- 应用中心
- 应用管控
- 云应用API
- 附录
- 修订记录
-
常见问题
-
管理员常见问题
- 云桌面有哪些特点和优势?
- 云桌面是如何计费的?
- 如何查看配额?
- 如何扩大配额?
- 如何新增磁盘?
- 如何使终端用户可使用本地打印机?
- 如何使终端用户可使用网络打印机?
- 云桌面对接AD失败怎么办?
- 云桌面的用户认证方式是否可修改?
- 如何启用AD服务器的LDAPS服务?
- 如何导出已启用LDAPS的AD服务器的根证书?
- 购买桌面失败怎么办?
- 云桌面管理控制台中提示“服务被锁定,请取消服务后重新开户”或“购买桌面、创建用户、创建策略、开通互联网”的按钮已置灰,无法使用怎么办?
- 云桌面支持使用私有镜像购买桌面吗?
- 云桌面最多支持创建多少个私有镜像?
- 接入桌面有怎样的网络要求?
- 云桌面无法访问互联网怎么办?
- 如何配置云桌面访问公网?
- 如何配置云桌面访问企业内网?
- 如何通过其他云服务页面开通互联网?
- 如何控制云桌面与本地存储设备之间的文件复制?
- 管理员账号的密码遗失怎么办?
- 管理员如何解锁终端用户账号?
- 终端用户登录桌面失败如何处理?
- 云桌面如何进行备份恢复?
- 导入策略提示名称重复如何处理?
- 管理员解绑MFA后,用户通过之前绑定的MFA动态验证码重新在客户端绑定用户失败怎么办?
- 开通委托的时候提示”IAM账号权限不足,当前操作需要Security Administrator权限”如何处理?
- 云桌面开通上网功能后,无法上网怎么处理?
- 用户没收到创建桌面/分配用户邮件如何处理?
- 购买云桌面后如何为企业项目迁入/迁出资源?
- 云桌面安装火绒杀毒管理员桌面转镜像失败如何处理?
- 为什么按需计费的云桌面开机失败?
- 如何开启/关闭云桌面的应急模式?
- 云桌面如何开启IPv6?
- Windows云桌面如何开启RDP?
- 云桌面的登录状态为无法连接如何处理?
- 如何收集云桌面的日志?
- 如何将租户配置下的DNS地址配置在VPC的子网内?
- 使用自定义安全组时,如何配置安全组规则?
- 云桌面内应用中心无法打开已经安装的软件如何处理?
- 接入云桌面时,如果有配置防火墙、安全组等访问控制,需要放通的云桌面相关业务IP与端口。
-
终端用户常见问题
-
桌面使用问题
- 桌面使用卡顿怎么办?
- 磁盘空间不足怎么办?
- 如何进入命令行模式?
- 云桌面无法连接外网怎么办?
- 云桌面是否支持个性化设置?
- 如何快速截图?
- 云桌面中无法使用本地打印机怎么办?
- 云桌面中无法使用网络打印机怎么办?
- 如何下载软件?
- 如何手动添加UOS操作系统云桌面数据盘?
- 如何扩容UOS磁盘容量至新增磁盘分区?
- 如何扩容UOS磁盘容量至已有磁盘分区?
- 重建系统盘后Windows桌面的数据盘消失了怎么办?
- 无法在云桌面与本地存储设备之间复制文件怎么办?
- 云桌面屏幕无法适配怎么办?
- 云桌面中可以登录淘宝网吗?
- 云桌面中可以访问手机淘宝吗?
- 用户没收到创建桌面/分配用户邮件怎么办?
- Windows云桌面如何手动配置时间同步?
- Linux云桌面如何查看Agent版本号?
- 云桌面跃点数异常如何修复?
- 登录问题
- 终端绑定问题
- 操作系统问题
- 客户端问题
-
桌面使用问题
- 修订记录
-
管理员常见问题
- SDK参考
-
云应用用户指南
- 简介
-
管理员操作指南
- 操作流程
- 登录管理控制台
- 开通服务
- 创建用户
- 应用与镜像
- 服务器组
- 应用组
- 用户管理
- 策略组
- 监控分析
- OU管理
- 应用上网管理
- 协议组件升级
- 定时任务
- 存储
- 租户配置
- 私有镜像管理
- 配置个性化数据
- 订阅事件
- 权限管理
- 常用功能配置
- 监控
-
常见问题
- 云应用与云桌面的联系是什么?
- 可以发布哪些类型的应用?
- 应用发布失败怎么办?
- 如何部署AD服务器?
- 如何部署RD Licensing服务器?
- 如何配置RDS服务授权及安全策略?
- 如何在AD服务器上创建用户OU?
- 如何在AD服务器上创建用户组?
- 如何在AD服务器上创建用户?
- 如何配置云应用和Windows AD网络互通
- 如何登录APS服务器?
- 如何通过购买NAT和EIP服务使云应用可通过互联网访问?
- 如何查看配额?
- 如何扩大配额?
- 部分应用操作界面带黑边且无法移动,如何处理?
- 终端用户登录失败如何处理?
- 如何重置用户密码?
- 重新加域失败如何处理?
- 如何将ECS服务器加入云应用服务器的域中?
- 如何通过GPO组策略使域用户成为PC的本地管理员?
- 如何安装沙箱软件?
- 使用Google Chrome浏览器或bilibili播放器等播放视频无声音或者开启声音画面不动,如何处理?
- 启动沙箱应用,窗口无法向左上角拖动或者无法拖动如何处理?
- RD License服务器加入AD域失败如何处理?
- 接入共享桌面应用报错6030/6047如何处理?
- 云应用通过打开等方式操作应用服务器中文件资源,无法自动刷新如何处理?
- 如何更新/添加应用?
- 子账户如何授权使用云应用服务?
- 如何测算云应用的并发会话数?
- 云应用启动失败如何处理?
- 终端用户操作指南
- 修订记录
- 文档下载
- 通用参考
链接复制成功!
查询桌面池详情
功能介绍
指定桌面池Id查询详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/desktop-pools/{pool_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
pool_id |
是 |
String |
桌面池ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
桌面池ID。 |
name |
String |
桌面池名称。 |
type |
String |
桌面池类型。DYNAMIC:动态池,STATIC:静态池。 |
description |
String |
桌面池描述。 |
created_time |
String |
创建时间,格式为:UTC格式,例如“2022-05-11T11:45:42.000Z”。 |
charging_mode |
String |
计费模式,0:包周期,1:按需。 |
desktop_count |
Integer |
桌面池总桌面数量。 |
desktop_used |
Integer |
桌面池绑定用户的桌面个数。 |
availability_zone |
String |
可用区。 |
subnet_id |
String |
子网ID。 |
product |
ProductInfo object |
产品信息。 |
image_id |
String |
镜像ID。 |
image_name |
String |
镜像名称。 |
image_os_type |
String |
镜像OS类型。 |
image_os_version |
String |
镜像OS版本。 |
image_os_platform |
String |
镜像OS平台。 |
image_product_code |
String |
镜像的productCode(specCode)。 |
root_volume |
VolumeInfo object |
系统盘。 |
data_volumes |
Array of VolumeInfo objects |
数据盘列表。 |
security_groups |
Array of SecurityGroup objects |
桌面安全组。 |
disconnected_retention_period |
Integer |
动态池桌面断连多少分钟内,保留用户与桌面的绑定关系,超时后自动解绑。 |
enable_autoscale |
Boolean |
桌面池是否开启弹性伸缩类型,为false则表示不开启弹性伸缩,为true则表示开启弹性伸缩。 |
autoscale_policy |
AutoscalePolicy object |
弹性伸缩策略。 |
status |
String |
桌面池状态。
|
enterprise_project_id |
String |
企业项目ID。 |
in_maintenance_mode |
Boolean |
桌面池是否处于管理员维护模式。 |
desktop_name_policy_id |
String |
策略id,用于指定生成桌面名称策略。 |
参数 |
参数类型 |
描述 |
---|---|---|
product_id |
String |
产品ID。 |
flavor_id |
String |
产品规格ID。 |
type |
String |
产品类型。
|
cpu |
String |
CPU。 |
memory |
String |
内存。 |
descriptions |
String |
产品描述。 |
charge_mode |
String |
周期套餐标识,0表示包周期,1表示按需。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
批量操作磁盘的磁盘集合id。 |
type |
String |
桌面数据盘对应的磁盘类型,需要与系统所提供的磁盘类型相匹配。
|
size |
Integer |
磁盘容量,单位GB。 |
resource_spec_code |
String |
规格。 |
参数 |
参数类型 |
描述 |
---|---|---|
autoscale_type |
String |
弹性伸缩类型,ACCESS_CREATED:接入时创建,AUTO_CREATED:弹性伸缩。 |
max_auto_created |
Integer |
自动创建桌面上限。 |
min_idle |
Integer |
空闲桌面低于多少时开始自动创建桌面。 |
once_auto_created |
Integer |
一次自动创建桌面的数量。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops-pools/a130ab3a-72bf-4b71-baa9-af4987c8e338
响应示例
状态码: 200
正常。
{ "id" : "2c2be3fb-0013-48d5-a081-0731f3473997", "name" : "POOL2", "type" : "DYNAMIC", "description" : "string。", "created_time" : "2023-01-04T07:10:53.554Z", "charging_mode" : "1", "desktop_count" : 10, "desktop_used" : 5, "on_demand_desktop_num" : 0, "availability_zone" : "string", "subnet_id" : "string", "product" : { "product_id" : "workspace.x86.ultimate.large2", "flavor_id" : "s6.large.2", "type" : "BASE", "cpu" : "2", "memory" : "4096", "descriptions" : "尊享办公|2核|4GB内存。", "charge_mode" : "1", "architecture" : "x86", "is_gpu" : false, "package_type" : "ultimate", "system_disk_type" : "SAS", "system_disk_size" : "80", "contain_data_disk" : false, "resource_type" : "hws.resource.type.workspace.desktop", "cloud_service_type" : "hws.service.type.vdi", "volume_product_type" : "workspace", "status" : "normal", "sub_product_list" : [ ] }, "image_id" : "string", "image_name" : "string", "image_os_type" : "string", "image_os_version" : "string", "image_os_platform" : "string", "image_product_code" : "string", "root_volume" : { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" }, "data_volumes" : [ { "id" : "string", "type" : "string", "size" : 8200, "cluster_id" : "string", "resource_spec_code" : "string" } ], "security_groups" : [ { "id" : "string", "name" : "string" } ], "disconnected_retention_period" : 10, "enable_autoscale" : true, "autoscale_policy" : { "autoscale_type" : "AUTO_CREATED", "max_auto_created" : 1000, "min_idle" : 100, "once_auto_created" : 10 }, "status" : "STEADY", "enterprise_project_id" : "0", "in_maintenance_mode" : false, "desktop_name_policy_id" : "TEST" }
状态码
状态码 |
描述 |
---|---|
200 |
正常。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。