检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 表1 云桌面接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 租户配置 修改、获取云办公服务接入地址备份配置及查询、修改、更新租户配置等功能。 桌面 查询、创建、修改、删除桌面等接口。 桌面池 查询、创建、修改、删除桌面池等接口。
如何调用API 构造请求 认证鉴权 返回结果
调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
云应用API 产品套餐管理 可用区管理 磁盘管理 服务器组管理 服务器管理 应用组管理 应用管理 应用授权管理 使用记录 策略管理 存储管理 任务管理 配额管理 服务器组标签管理 应用仓库管理 镜像管理 订单 定时任务 租户配置
云桌面API 云办公服务 租户配置 桌面 桌面池 桌面名称策略 桌面标签 协同桌面 用户 用户组 组织单元 磁盘 快照 连接信息 策略组 终端与桌面绑定 订单 询价 产品套餐 定时任务 报表统计 告警 用户操作日志 脚本 配额 镜像 可用分区 任务 网络 委托 应用中心 应用管控
云桌面错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 WKS.0001 接口输入的请求消息为空。 接口输入的请求消息为空。 请参考返回的error message信息检查请求体。
云应用错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
获取账号ID 在调用接口的时候,部分URL中需要填入账号ID,所以需要先在管理控制台上获取到账号ID。账号ID获取步骤如下: 登录管理控制台。 单击用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面中查看账号ID。 图1 获取账号ID 父主题: 附录
resource-path:资源路径,也即API访问路径。从具体API的URI模块获取,例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。 query-string:查询参数,是可选部分,并不是每个API都有查询参数。
应用管控 创建应用规则 查询应用规则 修改应用规则 删除应用规则 批量删除规则 启用规则管控 禁用规则管控 增加管控规则 查询管控规则列表 批量删除管控规则列表 父主题: 云桌面API
脚本 新增脚本 查询脚本列表 查询脚本详情 更新脚本 删除脚本 批量执行脚本或命令 查询脚本执行记录详情 查询脚本执行记录列表 查询脚本任务列表 重试脚本或执行脚本失败的任务 停止脚本或者命令执行任务 父主题: 云桌面API
应用管理 发布应用 查询已发布应用 修改应用信息 批量取消应用发布 可发布应用列表 批量启用应用 批量禁用应用 查询应用详细信息 修改自定义应用图标 删除自定义应用图标 父主题: 云应用API
配额 查询租户配额 查询租户单个站点配额详情 父主题: 云桌面API
产品套餐管理 查询云应用套餐 查询会话套餐列表 查询会话套餐列表 父主题: 云应用API
任务管理 子任务数量查询 子任务查询 批量删除子任务 查询租户的镜像任务列表 查询镜像任务详情 镜像子任务查询 批量删除镜像子任务 查询任务的执行状态 查询任务的执行状态 父主题: 云应用API
获取云办公服务接入地址备份配置 查询租户的NAT映射配置项 修改租户的NAT映射配置项 查询租户个性配置列表 修改租户个性配置 查询协同桌面默认用户配置 设置协同桌面默认用户配置 查询认证登录方式 更新认证策略配置 查询辅助认证配置 更新辅助认证策略配置 启禁用租户功能 查询租户功能状态 父主题: 云桌面API
版本信息 批量设置桌面维护模式 预批量分配用户 批量分配用户 AD场景支持桌面更换关联用户名 发送消息通知 查询桌面安装agent详情 安装agent 根据桌面id查询远程协助信息 创建远程协助 取消远程协助 查询桌面连接状态列表 根据子网id查询该子网下可用的ip 父主题: 云桌面API
任务 重试任务 查询任务详情 子任务查询 删除子任务 父主题: 云桌面API
镜像 获取云市场镜像列表 查询产品镜像列表 父主题: 云桌面API
委托 开通委托功能 查询委托功能 父主题: 云桌面API