- 最新动态
- 服务公告
- 功能总览
- 产品介绍
- 快速入门
- 用户指南(终端用户)
- 用户指南(管理员)
- 最佳实践
-
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如何处理?
- 云应用通过打开等方式操作应用服务器中文件资源,无法自动刷新如何处理?
- 如何更新/添加应用?
- 子账户如何授权使用云应用服务?
- 如何测算云应用的并发会话数?
- 云应用启动失败如何处理?
- 终端用户操作指南
- 修订记录
- 文档下载
- 通用参考
链接复制成功!
查询桌面列表
功能介绍
该接口用于查询桌面虚拟机列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/desktops
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
user_name |
否 |
Array of strings |
桌面所属用户。 |
computer_name |
否 |
String |
桌面名。 |
desktop_ip |
否 |
String |
桌面IP地址。 |
offset |
否 |
Integer |
用于分页查询,查询的起始记录序号,从0开始。 |
limit |
否 |
Integer |
用于分页查询,取值范围0-1000,默认值1000。 |
pool_id |
否 |
String |
桌面池ID,多个桌面池ID用逗号隔开。 |
enterprise_project_id |
否 |
String |
企业项目ID。 |
desktop_type |
否 |
String |
桌面类型,为空时查所有桌面。查询多个类型时用,隔开。
|
is_share_desktop |
否 |
Boolean |
是否为协同桌面。 |
subnet_id |
否 |
String |
桌面的子网ID。 |
status |
否 |
String |
桌面的运行状态。 |
desktop_id |
否 |
Array of strings |
桌面id,当前最多支持100个桌面id进行查询。 |
tag |
否 |
String |
桌面的标签。样例:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
否 |
String |
发送的实体的MIME类型。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Integer |
总数。 |
desktops |
Array of SimpleDesktopInfo objects |
桌面信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
desktop_id |
String |
桌面ID。 |
computer_name |
String |
桌面名。 |
os_host_name |
String |
系统计算机名。 |
created |
String |
创建时间。 |
ip_address |
String |
桌面ip地址。 |
user_name |
String |
用户名。 |
attach_user_infos |
Array of AttachInstancesUserInfo objects |
桌面已分配的用户信息列表。 |
user_group |
String |
权限组。 |
sid |
String |
桌面的SID信息。 |
ou_name |
String |
ou名称。 |
enterprise_project_id |
String |
企业项目ID。 |
tags |
Array of Tag objects |
标签列表。 |
in_maintenance_mode |
Boolean |
是否处于管理员维护模式。 |
share_resource_sku |
String |
桌面协同资源SKU码。 |
desktop_type |
String |
桌面类型。 |
subnet_id |
String |
桌面的子网ID。 |
bill_resource_id |
String |
桌面计费资源ID。 |
status |
String |
桌面的运行状态。 |
task_status |
String |
桌面的任务状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在; |
user_name |
String |
桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。
|
user_group |
String |
桌面用户所属的用户组。
|
type |
String |
对象类型,可选值为:
|
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
标签的键,不能为空,最大长度128个unicode字符。大小写字母,数字,可以包含中划线“-”,下划线“_”,不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 |
value |
String |
标签的值,最大长度43个unicode字符。大小写字母,数字,可以包含中划线“-”,下划线“_”,不能包含以下字符“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 |
状态码: 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/bcae3e673fd04716a3b9dacdf58ca336/desktops
响应示例
状态码: 200
查询云桌面列表响应。
{ "total_count" : 2, "desktops" : [ { "desktop_id" : "a6f6e2d1-cc62-46f3-865b-9ae6ae0afde0", "computer_name" : "ZRYUAN107", "created" : "2022-02-23 04:02:07", "ip_address" : "10.0.9.25", "user_name" : "zryuan1", "user_group" : "administrators", "sid" : "3db90102-d11d-4d13-9a96-104696d3c6a3", "in_maintenance_mode" : false, "share_resource_sku" : "workspace.collaborativedesktop.6party.standard" }, { "desktop_id" : "248077ea-bb64-4e58-b5e8-6b686600920e", "computer_name" : "CHENYC01", "created" : "2022-02-22 12:14:59", "ip_address" : "10.0.9.103", "user_name" : "chenyc", "user_group" : "administrators", "sid" : "352cf09d-ee15-4ef1-aa49-8d673972b4e6", "in_maintenance_mode" : true, "share_resource_sku" : "workspace.collaborativedesktop.6party.standard" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
查询云桌面列表响应。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。