API概览 表1 云桌面接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 租户配置 修改、获取云办公服务接入地址备份配置及查询、修改、更新租户配置等功能。 桌面 查询、创建、修改、删除桌面等接口。 桌面池 查询、创建、修改、删除桌面池等接口。
云应用API 产品套餐管理 可用区管理 磁盘管理 服务器组管理 服务器管理 应用组管理 应用管理 应用授权管理 使用记录 策略管理 存储管理 任务管理 配额管理 服务器组标签管理 应用仓库管理 镜像管理 订单 定时任务 租户配置 CloudStorage
如何调用API 构造请求 认证鉴权 返回结果
云桌面API 云办公服务 租户配置 桌面 桌面池 桌面名称策略 桌面标签 协同桌面 用户 用户组 组织单元 磁盘 快照 连接信息 策略组 终端与桌面绑定 订单 询价 产品套餐 定时任务 报表统计 告警 用户操作日志 脚本 配额 镜像 可用分区 任务 网络 委托 应用中心 应用管控
云应用错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
云桌面错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 WKS.0001 接口输入的请求消息为空。 接口输入的请求消息为空。 请参考返回的error message信息检查请求体。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
脚本 新增脚本 查询脚本列表 查询脚本详情 更新脚本 删除脚本 批量执行脚本或命令 查询脚本执行记录详情 查询脚本执行记录列表 查询脚本任务列表 重试脚本或执行脚本失败的任务 停止脚本或者命令执行任务 父主题: 云桌面API
快照 批量创建快照 批量删除快照 批量恢复快照 查询快照列表 父主题: 云桌面API
订单 包周期下单 创建变更订单 包周期桌面批量变更下单 包周期桌面池批量变更下单 包周期云办公带宽变更下单 创建桌面订单 父主题: 云桌面API
订单 创建订单 父主题: 云应用API
查询已绑定桌面和未绑定的EIP 开通桌面上网功能 桌面绑定EIP 批量桌面解绑EIP 查询正在被使用的子网id列表 查询端口列表 查询NAT网关列表 创建云办公带宽 查询云办公带宽列表 修改云办公带宽 删除云办公带宽 查询云办公带宽的控制配置 修改云办公带宽的控制配置 父主题: 云桌面API
用户 查询用户列表 创建用户 删除指定用户 查询用户详情信息 修改用户信息 批量删除用户 批量创建用户 操作用户 给用户重置随机密码 查询OTP设备 解绑OTP设备 重新发送邮件 父主题: 云桌面API
版本信息 批量设置桌面维护模式 预批量分配用户 批量分配用户 AD场景支持桌面更换关联用户名 发送消息通知 查询桌面安装agent详情 安装agent 根据桌面id查询远程协助信息 创建远程协助 取消远程协助 查询桌面连接状态列表 根据子网id查询该子网下可用的ip 父主题: 云桌面API
任务 重试任务 查询任务详情 子任务查询 删除子任务 父主题: 云桌面API
配额 查询租户配额 查询租户单个站点配额详情 父主题: 云桌面API
委托 开通委托功能 查询委托功能 父主题: 云桌面API
告警 查询告警列表 查询告警统计 父主题: 云桌面API
镜像 获取云市场镜像列表 查询产品镜像列表 父主题: 云桌面API
您即将访问非华为云网站,请注意账号财产安全