检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询任务的执行状态 功能介绍 查询Job的执行状态。 对于创建云服务器、删除云服务器、重建镜像等异步API，下发命令后会返回job_id，通过job_id可以查询任务的执行状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自
构建云应用镜像 功能介绍 构建云应用镜像。 只允许对状态为 实例正常运行、镜像任务结束 的实例构建云应用镜像。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST
查询任务的执行状态 功能介绍 查询Job的执行状态。 对于创建云应用服务器命令下发后会返回job_id，通过job_id可以查询任务的执行状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
查询初始策略项 功能介绍 查询初始策略项，初始策略项是所有协议策略配置项的默认配置，用户可以在初始策略项的基础上根据需求修改指定的配置，创建新的策略组。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
购买包年/包月云应用服务器 场景描述 购买包年/包月云应用服务器可以使用创建云服务器接口，相对于创建按需的云应用服务器，只需要在请求body中指定create_server_extend_param.charging_mode参数值为“prePaid”，即包年包月，指定订购的周期
Workspace运维监控指标 功能说明 本节定义了云桌面的各种监控指标，各项监控指标的具体含义与使用说明，详情如表1所示。 表1 云桌面支持的运维监控指标 指标ID 指标名称 指标含义 统计维度 维度赋值示例 统计类型（使用/metric接口查询的返回值计算方式） 统计周期 最大查询时间范围
批量取消应用发布 功能介绍 批量取消应用发布。 批量取消应用组下已经发布的应用，应用对应的授权会一起删除，重复执行会按照成功处理(响应200)。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 Token认证：通过Token认证调用请求。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key)加密调用请求。 AK/SK认证 AK/SK签名认证方式仅支持消息
分发软件信息至镜像实例 功能介绍 分发应用软件信息至镜像实例，管理员可以按需下载并安装应用软件。 目前只支持来自云应用仓库的软件信息。 只允许对状态为 实例正常运行、镜像任务结束 的实例分发软件信息。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API
批量删除服务器 功能介绍 批量删除服务器。 仅支持删除按需订购的服务器，包周期订购的服务器需要到Console界面进行退订，订单退订成功后服务器将会自动删除。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
在桌面分配类型选择“暂不分配”。 2.根据实际需求输入暂不分配用户的桌面名称。 桌面用户类型 单人：一台桌面只能分配给一个用户。 多人：一台桌面可分配给多个用户，同时在线的只有1人。购买完成后可在桌面列表操作分配用户中添加多人。 - 桌面命名规则 不使用命令规则。 选择所需的命名规则。 说明： 如需创建新的
修改服务器 功能介绍 修改服务器。 服务器的状态修改为维护模式后，用户打开应用，选择可用的服务器进行接入的时候，会过滤掉处于维护模式的服务器。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
包年/包月云应用服务器续费 场景描述 包年/包月资源即将到期时，可进行包年/包月资源的续订。通过调用续订包年/包月资源接口进行续费。 示例： 如下所示，指定资源ID，按月续费，续费1个月，到期后转按需，并自动支付订单。 POST https://bss.myhuaweicloud
删除服务器组 功能介绍 删除服务器组。 删除服务器组之前，需要先删除服务器组内的所有服务器。如果传服务器组已被删除，重复执行删除，则返回成功响应。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
API概览 表1 云桌面接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 租户配置 修改、获取云办公服务接入地址备份配置及查询、修改、更新租户配置等功能。 桌面 查询、创建、修改、删除桌面等接口。 桌面池 查询、创建、修改、删除桌面池等接口。 桌面名称策略 查
修订记录 发布日期 修订记录 2025-01-03 第二十六次正式发布。 新增： 用户操作日志目录及目录下接口。 应用管控目录下新增查询应用分类信息、按照名称分页查询应用、添加应用、批量设置应用授权、批量自动安装安装应用、批量删除应用、批量设置不可见、批量设置可见、删除应用、修改
构造请求 操作场景 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。 请求URI 请求URI由如下部分组成：
创建服务器组 功能介绍 创建服务器组。 服务器组是一组相同配置的服务器集合，服务器组内的服务器使用同一镜像创建，配置相同，运行相同的应用程序。用户在打开云应用时，会根据调度规则选取组内的一台可用服务器进行连接。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API
云桌面错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 WKS.0001 接口输入的请求消息为空。 接口输入的请求消息为空。 请参考返回的error message信息检查请求体。 200
配置高级策略参数 操作场景 在配置策略过程中，如有特殊场景需求，可针对特殊场景需求的个性化定制的“高级策略”进行配置。 通过以下几个方面进行应用策略的定制及规划，创建出满足用户真实需求的优质、高效的策略管理方案。 表示该项策略已启用。 表示该项策略已禁用。 外设 音频 客户端 显示
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
