华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_ids 否 Array of strings 计算机id列表。 message 否 String 下发注销桌面任务时，给用户发送的提示信息。

响应参数 状态码： 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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型 表3 请求Body参数 参数 是否必选 参数类型 描述 policy 是 AccessPolicyInfo object 接入策略信息。 policy_objects_list 否 Array of AccessPolicyObjectInfo objects 策略应用对象列表。 表4 AccessPolicyInfo 参数 是否必选 参数类型 描述 policy_name 否 String 策略名 blacklist_type 否 String 黑名单类型，当前黑名单只支持互联网。 INTERNET： 互联网 access_control_type 否 String 访问控制类型。默认为接入类型 AC CES S_TYPE： 接入类型 IP_WHITE_LIST： IP白名单 ip_list 否 Array of IpInfo objects 策略的ip列表。 表5 IpInfo 参数 是否必选 参数类型 描述 ip_address 是 String ip地址。 subnet_mask 是 String 子网掩码。 表6 AccessPolicyObjectInfo 参数 是否必选 参数类型 描述 object_id 是 String 黑名单中的对象id。 object_type 是 String 对象类型。 USER： 用户 USERGROUP： 用户组 object_name 否 String 对象名。后续此参数不会校验。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 用户组描述。 group_name 否 String 用户组名，注意AD用户组不支持改名。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 unused_desktops Array of UnusedDesktopInfo objects 指定时间段内未使用桌面列表。 total_count Integer 总数。 表5 UnusedDesktopInfo 参数 参数类型 描述 desktop_id String 桌面id。 compute_name String 桌面名称。 create_time String 桌面创建时间。 disconnect_time String 最近一次断连时间。 状态码： default 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

响应示例 状态码： 200 查询在指定时间段未使用的桌面响应。 { "unused_desktops" : [ { "desktop_id" : "e0367f84-1d64-498e-9b92-093002ac3ce8", "compute_name" : "ZYZ08", "create_time" : "2022-08-08T02:34:05.202Z", "disconnect_time" : "2022-08-08T02:39:00.000Z" }, { "desktop_id" : "b8eb2ac0-4540-4409-857f-df5e2de07546", "compute_name" : "wangyan8301", "create_time" : "2022-08-08T02:34:05.202Z", "disconnect_time" : "2022-08-08T02:39:00.000Z" } ], "total_count" : 2 }

URI GET /v2/{project_id}/desktops/statistics/unused 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 从查询结果中的第几条数据开始返回,用于分页查询，取值范围0-2000，默认从0开始。 limit 否 Integer 查询结果中想要返回的信息条目数量,用于分页查询，取值范围0-2000，默认值1000。 start_time 否 String 开始时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。 end_time 否 String 结束时间：由日期加时间组成，UTC格式，格式：yyyy-MM-ddTHH:mm:ss.SSSZ，若未输入，则查询现在到前一天的未使用的桌面。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 任务id task_type String 任务类型。START：开机，STOP：关机，REBOOT：重启，HIBERNATE：休眠，REBUILD：重建系统盘，EXECUTE_SCRIPT：执行脚本。scheduled_type为LIFE_CYCLE时，不支持START、REBUILD。 task_name String 任务名称。 force_execute Boolean 是否强制执行。 scheduled_type String 执行周期类型。FIXED_TIME：指定时间，DAY：按天，WEEK：按周，MONTH：按月，LIFE_CYCLE：指定场景下触发。 life_cycle_type String 触发场景类型。仅当scheduled_type为LIFE_CYCLE时，生效。POST_CREATE_DESKTOP_SUCCESS：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后。 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。 description String 描述。 extra_params String 扩展参数，json格式。 apply_objects Array of ApplyObject objects 定时任务应用的对象列表。 gray_count Integer 灰度对象数量，优先级高于gray_desktop_ids。 gray_desktop_ids Array of strings 灰度执行的桌面id列表，优先级低于gray_count。 gray_fail_threshold Integer 灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。 time_zone String 时区。 wait_time Integer 触发式任务触发后，等待时长。 表4 ApplyObject 参数 参数类型 描述 object_id String 对象ID。 object_type String 对象类型，可选值为： DESKTOP：桌面。 DESKTOP_POOL：桌面池。 ALL_DESKTOPS: 所有桌面，仅供触发式任务使用。 DESKTOP_TAG：桌面标签 object_name String 对象名称。 状态码： 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接口进行解密。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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接口进行解密。 状态码： 500 表9 响应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类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 operate_type 否 String 解除项目锁定操作类型。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 future_executions Array of strings 未来执行的具体时间列表。 状态码： 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_SUCCESS：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。 time_zone 否 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接口进行解密。 状态码： 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的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 vpc_id 是 String 待切换VPC的ID subnet_id 是 String 待切换子网的ID private_ip 否 String 指定私有IP地址 security_group_ids 是 Array of strings 安全组ID列表

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务id。 状态码： 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接口进行解密。 状态码： 409 表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接口进行解密。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 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接口进行解密。 状态码： 409 表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接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 volume_ids 否 Array of strings 待删除的桌面数据盘ID列表。

响应参数 状态码： 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接口进行解密。 状态码： 405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表10 响应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类型 表3 请求Body参数 参数 是否必选 参数类型 描述 policy_id_list 否 Array of strings 策略ID列表。

响应示例 状态码： 200 查询桌面云用户列表响应。 { "total_count" : 2, "users" : [ { "id" : "8a2c3f9579d240820179d51e6caf0001", "user_name" : "api-test", "user_email" : "test@huawei.com", "total_desktops" : 0, "account_expires" : "0", "enable_change_password" : true, "next_login_change_password" : true, "locked" : false, "disabled" : false }, { "id" : "8a2c3f9579d240820179d51e6caf0002", "user_name" : "api-test2", "user_email" : "test@huawei.com", "total_desktops" : 0, "account_expires" : "0", "enable_change_password" : true, "next_login_change_password" : true, "locked" : false, "disabled" : false } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 用户总数。 users Array of User objects 用户列表。 表5 User 参数 参数类型 描述 id String 用户ID。 sid String 用户ID。 user_name String 桌面用户名。 user_email String 用户邮箱。 total_desktops Integer 用户绑定桌面云总数。 user_phone String 手机号。 active_type String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 is_pre_user Boolean 是不是预创建的用户。 account_expires String 账户过期时间，0表示永远不过期。 password_never_expired Boolean 密码是否永不过期，true表示密码永不过期，false表示密码会过期。 account_expired Boolean 帐号是否过期，true表示已过期，false表示未过期。 enable_change_password Boolean 是否允许修改密码，true表示允许，false表示不允许。 next_login_change_password Boolean 下次登录是否需要重置密码，true表示需要重置密码，false表示不需要。 description String 用户描述。 locked Boolean 账户是否被锁定，true表示被锁定，false表示未锁定。 disabled Boolean 账户是否禁用，true表示被禁用，false表示未禁用。 share_space_subscription Boolean 用户是否订阅协同，true表示已订阅，false表示未订阅 share_space_desktops Integer 用户已绑定协同桌面数 group_names Array of strings 加入的组列表。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 405 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： 503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

URI GET /v2/{project_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 user_name 否 String 桌面用户名，长度范围为1-20，不能包含特殊字符，不能以数字开头。 limit 否 String 用于分页查询，返回用户数量限制。如果不指定，则返回所有符合条件的用户。 offset 否 String 分页查询起始条数。 description 否 String 用户描述查询，模糊匹配。 active_type 否 String 激活类型，默认为用户激活。 USER_ACTIVATE： 用户激活 ADMIN_ACTIVATE： 管理员激活 group_name 否 String 桌面用户组名，精确匹配。 share_space_subscription 否 Boolean 用户是否已订阅协同，true/false share_space_desktops 否 Boolean 用户是否已绑定协同桌面,true/false is_query_total_desktops 否 Boolean 是否查询用户绑定的桌面数,true/false,默认true

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 existing_agencies Array of AgenciesInfo objects 委托信息 表5 AgenciesInfo 参数 参数类型 描述 name String 名称 permissions Array of AgenciesPermissionInfo objects 委托权限信息 表6 AgenciesPermissionInfo 参数 参数类型 描述 system_permission_display_names Array of strings 委托权限项 wanted_system_permission_display_names Array of strings 需要委托的权限项 状态码： 400 表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接口进行解密。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 状态码： default 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 encoded_authorization_message String 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 否 String 发送的实体的MIME类型。 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktop_volumes 否 Array of AddDesktopVolumesReq objects 新增磁盘参数。 表4 AddDesktopVolumesReq 参数 是否必选 参数类型 描述 desktop_id 否 String 桌面Id。 volumes 否 Array of Volume objects 待新增的磁盘信息，每个桌面的数据盘数量不超过10个。 表5 Volume 参数 是否必选 参数类型 描述 type 是 String 桌面数据盘对应的磁盘类型，需要与系统所提供的磁盘类型相匹配。 -SAS：高IO。 -SSD：超高IO。 -GPSSD：通用型SSD。 size 是 Integer 磁盘容量，单位GB。系统盘大小范围[80-32760]，数据盘范围[10-32760]，大小为10的倍数。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 job_id String 增加磁盘任务ID 状态码： 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接口进行解密。 状态码： 409 表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接口进行解密。

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

请求示例 PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config { "auth_type" : "OTP", "otp_config_info" : { "enable" : true, "receive_mode" : "VMFA", "apply_rule" : { "rule_type" : "ACCESS_MODE", "rule" : "INTERNET" } } } PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config { "auth_type" : "OTP", "otp_config_info" : { "enable" : true, "receive_mode" : "HMFA", "auth_url" : "https://10.0.0.128:8443/api/um/login", "app_id" : 123, "app_secret" : 123, "auth_server_access_mode" : "DEDICATED", "cert_content" : "cert_content", "apply_rule" : { "rule_type" : "ACCESS_MODE", "rule" : "INTERNET" } } }