华为云用户手册

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tc_bind_switch String 绑定开关，只取值ON或OFF tc_auto_bind_switch String 自动绑定开关，只取值ON或OFF tc_auto_bind_max Integer 最大绑定数量，默认值为1 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_name 否 String 策略名称，由数字、字母、中文、下划线组成，必须以字母或下划线开头，长度范围为1~30个字符。 name_prefix 否 String 策略前缀。 digit_number 否 Integer 策略后缀有效位数。 start_number 否 Integer 策略后缀起始数字。 single_domain_user_inc 否 Integer 是否单用户名递增。 1 单用户名递增。 0 租户递增。 is_default_policy 否 Boolean 是否为默认策略，true默认策略。

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 bind_list Array of TerminalsBindingDesktopsInfo objects MAC绑定VM信息列表 total_num Integer 返回结果总条数 表5 TerminalsBindingDesktopsInfo 参数 参数类型 描述 id String MAC绑定策略ID mac String 终端MAC地址 desktop_name String 虚拟机名称 description String 描述 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 正常 { "bind_list" : [ { "id" : "8ac225c2781edb0d01781edde3f4xxxx", "mac" : "AA-BB-CC-DD-EE-FF", "desktop_name" : "test01", "description" : "test" } ], "total_num" : 1 }

URI GET /v2/{project_id}/terminals/binding-desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 computer_name 否 String 桌面名。 mac 否 String mac地址。 offset 是 Integer 起始数。 limit 是 Integer 数量。 count_only 否 Boolean 是否只查询结果总条数

响应示例 状态码： 200 正常。 { "otp_devices" : [ { "id" : "5311a768c22f4d30914fe50ffdfd1ba5", "user_id" : "8a2c3f9579d240820179d51e6caf0001", "user_name" : "zhangsan", "status" : "UNREGISTER", "create_time" : "2020-04-10 06:45:14" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 otp_devices Array of OtpDevice objects otp设备。 表4 OtpDevice 参数 参数类型 描述 id String 用户otp 信息id。 user_id String 用户id。 user_name String 用户名。 status String 用户otp设备状态 UNREGISTER: 未绑定 REGISTERED：已绑定 create_time String 用户otp设备绑定时间。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询可用分区列表响应。 { "total_count" : 2, "availability_zones" : [ { "availability_zone" : "cn-north-4a", "display_name" : "cn-north-4a", "i18n" : { "zh_cn" : "可用区1", "en_us" : "AZ1" }, "sold_out" : { "products" : [ "workspace.k.2xlarge.2.linux" ] }, "product_ids" : [ "workspace.k.xlarge.2.linux" ], "visible" : "true,", "default_availability_zone" : false }, { "availability_zone" : "cn-north-4b", "display_name" : "cn-north-4b", "i18n" : { "zh_cn" : "可用区2", "en_us" : "AZ2" }, "sold_out" : { "products" : [ "workspace.k.large.2.linux" ] }, "product_ids" : [ "workspace.k.large.2.linux" ], "visible" : true, "default_availability_zone" : false } ] }

URI GET /v2/{project_id}/scheduled-tasks/{task_id}/records/{record_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 task_id 是 String 任务ID。 record_id 是 String 任务执行记录ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 用于分页查询，查询的起始记录序号，从0开始。 limit 是 Integer 用于分页查询，每页返回的个数，取值范围0~100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 tasks_records_details Array of ScheduledTasksRecordsDetails objects 定时任务执行记录详情列表。 total_count Integer 总个数。 表5 ScheduledTasksRecordsDetails 参数 参数类型 描述 id String 任务执行记录详情id record_id String 任务执行记录id desktop_id String 桌面id desktop_name String 桌面名称。 exec_status String 执行状态。 exec_script_id String 执行脚本id。 result_code String 失败或者跳过原因的错误码。 fail_reason String 失败或者跳过原因。 start_time String 执行开始时间，格式为yyyy-MM-dd HH:mm:ss。 end_time String 执行结束时间，格式为yyyy-MM-dd HH:mm:ss。 time_zone String 时区 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 scheduled_type 否 String 执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。 LIFE_CYCLE：指定场景下触发。 day_interval 否 Integer 周期按天时：按x天间隔执行。 week_list 否 String 周期按周时：取值1~7，分别对应周日~周六，英文逗号分隔，如1,2,7。 month_list 否 String 周期按月时：取值1~12，英文逗号分隔，如1,3,12。 date_list 否 String 周期按月时：取值1~31及L(代表当月最后一天)，英文逗号分隔，如1,2,28,L。 scheduled_date 否 String 周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。 scheduled_time 否 String 指定的执行时间点，格式为HH:mm:ss。 expire_time 否 String 到期时间，格式为yyyy-MM-dd HH:mm:ss。 gray_count 否 Integer 灰度对象数量，优先级高于gray_desktop_ids。只支持脚本执行。 gray_desktop_ids 否 Array of strings 灰度执行的桌面id列表，优先级低于gray_count。只支持脚本执行。 gray_fail_threshold 否 Integer 灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。只支持脚本执行。 life_cycle_type 否 String 触发场景。POST_CREATE_DESKTOP_SUC CES S：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。 time_zone 否 String 时区。 task_type 是 String 任务类型，可选值为： START：开机。 STOP：关机。 REBOOT：重启。 HIBERNATE：休眠。 REBUILD：重建系统盘。 EXECUTE_SCRIPT：执行脚本。 CREATE_SNAPSHOT：创建快照。 task_name 是 String 任务名称。 force_execute 否 Boolean 是否强制执行，true表示强制执行，false表示不强制执行。 description 否 String 描述。 extra_params 否 String 扩展参数，json格式。 apply_objects 否 Array of ApplyObject objects 定时任务应用的对象列表。 wait_time 否 Integer 触发式任务触发后，等待时长。 表4 ApplyObject 参数 是否必选 参数类型 描述 object_id 否 String 对象ID。 object_type 否 String 对象类型，可选值为： DESKTOP：桌面。 DESKTOP_POOL：桌面池。 ALL_DESKTOPS: 所有桌面，仅供触发式任务使用。 DESKTOP_TAG：桌面标签

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 is_lock Integer 云办公服务是否被锁定，0代表未锁定，1代表锁定。 lock_time String 云办公服务锁定时间，格式：yyyy-MM-dd HH:mm:ss，时区：UTC。 lock_reason String 云办公服务锁定原因。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 items Array of DesktopMetric objects 桌面统计指标 表5 DesktopMetric 参数 参数类型 描述 resource_id String 桌面ID resource_pool_id String 桌面池ID(仅桌面池中的桌面存在该字段) resource_name String 桌面名称 metric Array of Metric objects 统计信息 desktop_usage - 桌面使用时长(单位:秒) desktop_idle_duration - 桌面空闲时长(单位:秒) 表6 Metric 参数 参数类型 描述 metric_name String 指标名称 metric_value Double 指标值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

功能介绍 查询桌面使用统计信息; 云服务每天凌晨02:00进行聚合运算前一天00:00:00~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次，09:00~12:00,13:00~21:00,22:00~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00~12:00)+8hours(13:00~21:00)+2hours(22:00~00:00) 仅能查询最近180天已进行汇聚计算的数据

URI GET /v2/{project_id}/statistics/metrics/desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 查询起始时间(0时区) 云服务每天凌晨02:00进行聚合运算前一天00:00:00~23:59:59的使用时长,并将周期范围内的数据聚合到周期边界上 跨天的记录会按照统计周期进行计算 假设一天内桌面登录多次，09:00~12:00,13:00~21:00,22:00~01:00(次日): 则当天的累计使用时长数据会被汇聚到23:59:59这个点;总使用时长为 3hours(09:00~12:00)+8hours(13:00~21:00)+2hours(22:00~00:00) 如果查询的from-to不足一个周期内，可能造成查询到数据为空； end_time 是 String 查询截至时间(0时区) resource_name 否 String 资源名称(模糊匹配) min_idle_days 否 Integer 最小空闲天数 max_idle_days 否 Integer 最大空闲天数 min_idle_days、max_idle_days都非空时,max_idle_days必须大于等于min_idle_days否则可能查询不到数据 usage_min_hours 否 Integer 使用时长(hour)最小值 usage_max_hours 否 Integer 使用时长(hour)最大值(必须大于等于usage_min_hours) sort_field 否 String 按照指标进行排序 desktop_usage - 按照桌面使用时长排序 desktop_idle_duration - 按照桌面空闲周期排序 sort_type 否 String 按照指标进行排序的方向;需配合sort_field一起使用 DESC - 降序返回数据 ASC - 升序返回数据 offset 否 Integer 查询的偏移量,默认值0 limit 否 Integer limit范围[1-100],默认值0

API概览 表1 云桌面 接口说明 类型 说明 云办公服务 查询、开通、注销云办公服务等接口。 协同配置 查询，设置协同桌面默认用户配置接口。 桌面 查询、创建、修改、删除桌面等接口。 桌面池 查询、创建、修改、删除桌面池等接口。 协同桌面 桌面购买、删除附属资源等接口。 桌面名称策略 查询获取、创建、更新、删除桌面名称策略接口。 用户 查询、创建、删除用户等接口。 用户组 查询、创建、删除用户组等接口。 组织单元 查询OU、导入OU下用户信息接口。 磁盘 增加、扩容、删除磁盘接口。 连接记录 查询登录信息、导出连接记录等接口。 连接信息 查询登录信息、登录人数、导出连接记录等接口。 策略组 查询、创建、更新、删除接入策略等接口。 订单 创建桌面订单、包周期桌面/桌面池批量变更下单等接口。 产品套餐 查询产品套餐列表接口。 认证配置 查询、更新辅助认证配置接口。 报表统计 查询新增、更新、删除通知规则及查询用户和桌面统计数据等接口。 配额 查询租户配额接口。 镜像 查询产品镜像列表接口。 可用分区 查询可用分区列表接口。 桌面标签 查询指定桌面的标签信息。 快照 查询快照列表、批量创建、批量删除、批量恢复快照等接口。 任务 查询任务及子任务接口。 委托 查询开通、查询委托功能等接口。 网络 查询已绑定桌面和未绑定的EIP、桌面绑定EIP、开通桌面上网功能等接口。 定时任务 查询创建、修改、删除定时任务等接口。 接入配置 查询修改、获取云办公服务接入地址备份配置接口。 终端与桌面绑定 查询、增加、修改、设置终端与桌面绑定开关及配置等接口。 表2 云应用接口说明 类型 说明 产品套餐管理 查询云应用套餐及会话套餐列表接口。 可用区管理 查询可用分区列表接口。 磁盘管理 查询磁盘接口。 服务器组管理 查询、创建、删除、修改服务器组列表等接口。 服务器管理 查询、创建、删除、修改、启动、重启服务器等接口。 应用组管理 查询、创建、删除、修改应用组等接口。 应用管理 查询发布应用、修改应用信息等接口。 应用授权管理 查询应用组授权、移除授权等接口。 使用记录 查询应用使用记录、用户会话注销等接口。 策略管理 查询、创建、删除、修改策略等接口。 存储管理 查询、创建、删除WKS存储等接口。 查询Job状态 查询任务的执行状态接口。 配额管理 查询配额校验接口。 应用仓库管理 查询、创建、修改、删除应用仓库中的应用等接口。 镜像管理 查询、创建、修改、构建、删除镜像实例等接口。

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of CreateUserRequest objects 创建单个用户请求。 表4 CreateUserRequest 参数 是否必选 参数类型 描述 user_name 是 String 用户名称。 user_email 否 String 用户邮箱。 account_expires 否 String 账户过期时间，0表示永远不过期。时间格式：yyyy-MM-ddTHH:mm:ssZ或yyyy-MM-ddTHH:mm:ss.SSSZ。 active_type 否 String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 user_phone 否 String 用户手机号。 password 否 String 用户初始密码。管理员激活模式需要输入。 enable_change_password 否 Boolean 是否允许用户更改密码，缺省值为true，后续此字段无效，创建时都为true。 next_login_change_password 否 Boolean 下次登录是否必须更改密码，缺省值为true。后续此字段无效，创建时都为true。 group_ids 否 Array of strings 用户组的专有ID列表。 description 否 String 用户描述，字符串长度区间[0, 255]。 alias_name 否 String 别名。

URI GET /v2/{project_id}/desktops 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 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 桌面类型，为空时查所有桌面。查询多个类型时用,隔开。 DEDICATED：普通桌面，包括专享桌面、专属桌面等。 SHARED: 多用户共享桌面。 is_share_desktop 否 Boolean 是否为协同桌面 subnet_id 否 String 桌面的子网ID。 status 否 String 桌面的运行状态。 desktop_id 否 Array of strings 桌面id，当前最多支持100个桌面id进行查询。 tag 否 String 桌面的标签。样例： key1=value1。 key1=value1，key2=value2。

响应示例 状态码： 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 表4 响应Body参数 参数 参数类型 描述 total_count Integer 任务列表总数。 jobs Array of JobDetailInfo objects 任务列表。 表5 JobDetailInfo 参数 参数类型 描述 id String 子任务ID。 job_type String 任务类型。 entities JobEntities object 任务操作对象。 begin_time String 任务创建时间。 end_time String 任务结束时间。 status String 任务状态。 error_code String 任务执行失败时的错误码。 fail_reason String 任务失败原因。 host String 任务执行的服务器IP。 project_id String 项目ID。 job_id String 任务ID。 process Integer 任务进度。 attach_user String 关联用户。 entity String 操作对象。 ip_address String ip地址。 表6 JobEntities 参数 参数类型 描述 desktop_id String 桌面ID。 product_id String 套餐ID。 user_name String 用户名。 desktop_name String 桌面名称。 ip_address String ip地址。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 任务明细响应 { "total_count" : 2, "jobs" : [ { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "9d30c8ac-77b5-4453-80da-8f027223ee99" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:06:10", "id" : "e43caef5-e478-4624-9e8c-b0b636331cbc" }, { "status" : "RUNNING", "entities" : { "user_name" : "user-test-01", "product_id" : "workspace.c2.large.windows", "desktop_id" : "14cccba0-12a6-4b66-9fd9-57290328f8da" }, "job_id" : "0e2dae94-23ff-449a-bb9c-1b808cf2106d", "job_type" : "createDesktops", "begin_time" : "2020-04-10 06:45:14", "end_time" : "2020-04-10 07:05:49", "id" : "cf5043e9-dd94-43be-9c07-6dba5d43c4d2" } ] }

URI GET /v2/{project_id}/workspace-sub-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id。 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 任务状态 SUCCESS：成功。 RUNNING：运行中。 FAILED：失败。 WAITING：等待。 job_id 否 String 任务ID。 job_type 否 String 任务类型 createDesktops：创建桌面任务。 applyWorkspace：开通云桌面服务。 cancelWorkspace：注销云桌面服务。 expandVolumes: 扩容磁盘。 addVolumes: 添加磁盘。 desktop_pool_id 否 String 桌面池ID。 limit 否 Integer 用于分页查询，取值范围0~1000，默认1000。 offset 否 Integer 用于分页查询，查询的起始记录序号，从0开始。

响应示例 状态码： 200 成功响应。 { "id" : "bc05da52-89df-45ba-8146-13fe3ce7c45a", "name" : "ApiExpirezSr5_20230606221433888186", "description" : "", "image_id" : "0fd6c925-6349-49d6-8788-48263b129854", "os_type" : "Windows", "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "is_vdi" : false, "create_time" : "2023-06-06T14:14:36.416Z", "update_time" : "2023-06-06T14:14:36.416Z", "ou_name" : "", "extra_session_type" : "GPU", "extra_session_size" : 1, "app_type" : "COMMON_APP" }

请求示例 POST /v1/a4da8115c9d8464ead3a38309130523f/app-server-groups { "name" : "APIExplore测试应用服务器组", "image_id" : "", "os_type" : "Windows", "image_type" : "private", "image_product_id" : "00301-2019002-0--0", "description" : "", "route_policy" : { "max_session" : 1 }, "product_id" : "workspace.appstream.general.xlarge.2", "subnet_id" : "a5842cb4-5718-4b0a-8b27-3a3e9c74f977", "system_disk_type" : "SATA", "system_disk_size" : 60, "vpc_id" : "59785ba5-e5d5-4836-b9de-19f22ac15175", "ip_virtual" : { "enable" : false }, "is_vdi" : false, "availability_zone" : "", "app_type" : "COMMON_APP", "extra_session_type" : "GPU", "extra_session_size" : 1, "primary_server_group_id" : "e5d5-4836-b9de-19f22ac15175", "server_group_status" : false }

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 id String 服务器组的唯一标识。 name String 服务器组名称。 description String 服务器组描述。 image_id String 服务器组关联的镜像ID，用于创建对应组下的云服务器。 os_type String 系统类型，当前仅支持Windows。 Linux - Windows - Other - product_id String 产品id。 subnet_id String 网卡对应的子网ID。 system_disk_type String 磁盘类型，获取可用磁盘类型详见接口磁盘管理ListVolumeType。 ESSD - 极速型SSD SSD - 超高IO GPSSD - 通用型SSD SAS - 高IO SATA - 普通IO system_disk_size Integer 磁盘容量，单位GB。 is_vdi Boolean 是否为vdi单会话模式。 extra_session_type String 付费会话类型： GPU - GPU规格会话。 CPU - 普通CPU规格会话。 extra_session_size Integer 付费会话个数。 app_type String 服务器组应用类型： SESSION_DESKTOP_APP - 会话桌面app COMMON_APP - 普通app create_time String 服务器组创建时间 update_time String 服务器组更新时间 storage_mount_policy String 用户访问APS的应用时，对应NAS存储目录在APS上的挂载策略。 USER - 仅挂载个人目录。 SHARE - 仅挂载共享目录。 ANY - 挂载目录不做限制(个人和共享NAS存储目录都会自动挂载)。 enterprise_project_id String 企业项目ID(0表示默认企业项目Id) primary_server_group_ids Array of strings 主服务器组id列表。 secondary_server_group_ids Array of strings 备服务器组id列表。 server_group_status Boolean 服务器是否处于启用状态，true表示处于启用状态 false表示处于禁用状态。 site_type String 站点类型 - CENTER/IES site_id String 站点id app_server_flavor_count Integer 服务器配置总数量。 app_server_count Integer 服务器总数量。 app_group_count Integer 关联应用组的总数量。 image_name String 镜像名称。 product_info ProductInfo object 产品规格信息。 subnet_name String 子网名称。 scaling_policy ScalingPolicy object 弹性伸缩策略。 tags Array of TmsTag objects 标签信息 ou_name String 默认组织名称。 表8 ProductInfo 参数 参数类型 描述 product_id String 产品id。 flavor_id String 规格ID。 type String 产品类型： BASE：表示产品基础套餐，套餐镜像中不包括除操作系统之外的其他商业软件，私有镜像场景只能使用此类套餐。 ADVANCED：表示产品高级套餐，套餐镜像中包括了一些商业软件。 architecture String 产品架构，当前仅支持x86。 x86 arm cpu String CPU。 cpu_desc String CPU描述。 memory String 内存大小，单位兆：M。 is_gpu Boolean 是否是GPU类型的规格。 system_disk_type String 系统盘类型。 system_disk_size String 系统盘大小。 gpu_desc String GPU描述。 descriptions String 产品描述。 charge_mode String 套餐标识。 1：表示包周期。 0：表示按需。 contain_data_disk Boolean 套餐计费是否包含了数据盘。 resource_type String 资源类型。 cloud_service_type String 云服务类型。 volume_product_type String 磁盘产品类型。 sessions Integer 套餐默认支持的最大会话数。 status String 产品套餐在销售模式下的状态，取值自E CS 的cond:operation:status。 不配置时等同于normal在售状态。 normal - 正常商用 abandon - 下线（即不显示） sellout - 售罄 obt - 公测 obt_sellout - 公测售罄 promotion - 推荐(等同normal，也是商用) cond_operation_az String 产品套餐在可用区的状态，配套status使用。 说明： 此参数是AZ级配置，优选取此参数的值，某个AZ没有在此参数中配置时默认使用status参数的取值。 配置格式“az(xx)”。()内为某个AZ的flavor状态，()内必须要填有状态，不填为无效配置。 例如：套餐在某个region的az0正常商用，az1售罄，az2公测，az3正常商用，其他az显示下线，可配置为： “status”设置为：“abandon” 。 “cond_operation_az”设置为：“az0(normal), az1(sellout), az2(obt), az3(normal)”。 说明：如果flavor在某个AZ下的状态与status配置状态不同，必须配置该参数。 sub_product_list Array of strings 专属主机的子产品。 domain_ids Array of strings 产品属于专有的domainId。 package_type String 套餐类型： general：表示产品通用套餐。 dedicated：表示产品专属主机套餐。 expire_time String 产品套餐过期时间，产品将在改时间点后逐步下架。 support_gpu_type String 产品套餐支持的GPU类型。 表9 ScalingPolicy 参数 参数类型 描述 enable Boolean 是否启用策略,默认启用： 'true': 启用 'false': 禁用 max_scaling_amount Integer 最大扩容数量。 single_expansion_count Integer 单次扩容数量。 scaling_policy_by_session ScalingPolicyBySession object 基于会话的弹性策略。 表10 ScalingPolicyBySession 参数 参数类型 描述 session_usage_threshold Integer 分组的总会话使用率(达到该阈值后扩容)。 shrink_after_session_idle_minutes Integer 给定时间内无会话连接的的实例进行释放。 表11 TmsTag 参数 参数类型 描述 key String 键。最大长度128个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 两头不能有空白字符。 value String 值。每个值最大长度255个unicode字符。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格，以及以下字符： _ . : = + - @。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 401 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 403 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 404 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 405 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 500 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码： 503 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。