华为云用户手册

请求示例 { "desktops" : [ { "desktop_id" : "string", "user_name" : "string", "user_email" : "string", "user_group" : "string", "computer_name" : "string", "is_clear_data" : "true", "attach_user_infos" : [ { "user_id" : "string", "user_name" : "string", "user_group" : "string", "type" : "USER" } ] } ], "image_type" : "string", "image_id" : "string", "os_type" : "string", "order_id" : "string", "enterprise_project_id" : "0", "desktop_name_policy_id" : "string" }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 否 String 发送的实体的MIME类型。 表3 请求Body参数 参数 是否必选 参数类型 描述 desktops 否 Array of AttachInstancesDesktopInfo objects 桌面信息列表。 image_type 否 String 镜像类型，涉及变更镜像时需传（可选）。 image_id 否 String 模板ID，涉及变更镜像时需传（可选）。 desktop_name_policy_id 否 String 策略id，用于指定生成桌面名称策略，如果指定了桌面名称则优先使用指定的桌面名称。 表4 AttachInstancesDesktopInfo 参数 是否必选 参数类型 描述 desktop_id 否 String 待分配的桌面ID。 user_name 否 String 桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-32]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持32个字符。用户名不能与分配的机器名重名。 attach_user_infos为空时,必填,attach_user_infos优先级更高 user_email 否 String 合法用户邮箱，桌面分配成功后系统会通过发送邮件的方式通知用户。 user_group 否 String 桌面用户所属的用户组,attach_user_infos为空时,必填,attach_user_infos优先级更高。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 computer_name 否 String 桌面名，桌面名必须保证唯一。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）；以字母开头且不允许以中划线（-）结尾；长度范围为[1-15]。 is_clear_data 否 Boolean 该字段只有当解绑和绑定为同一个用户时生效。表示绑定时是否清理桌面数据，true：清理，false：不清理，默认值为true。 attach_user_infos 否 Array of AttachInstancesUserInfo objects 待分配的用户信息列表,只有多用户桌面分配多人时有效。 表5 AttachInstancesUserInfo 参数 是否必选 参数类型 描述 user_id 否 String 当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在； user_name 否 String 桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为[1-20]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为[1-64]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。 user_group 否 String 桌面用户所属的用户组。 sudo：Linux管理员组。 default：Linux默认用户组。 administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 type 否 String 对象类型，可选值为： USER：用户。 GROUP：用户组。

响应参数 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码：500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

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

请求示例 { "name" : "Huawei", "description" : "test。", "rule" : { "scope" : "PRODUCT", "product_rule" : { "identify_condition" : "productName", "publisher" : null, "product_name" : "HUAWEI", "process_name" : "Huawei.exe", "support_os" : "Windows", "version" : "1.0.0.1", "product_version" : "1.0.0.1" }, "path_rule" : { "path" : "D:\\\\tmp" } } }

响应示例 状态码：200 成功响应。 { "id" : "string", "name" : "string", "description" : "string。", "rule" : { "scope" : "PRODUCT", "product_rule" : { "identify_condition" : "productName", "publisher" : null, "product_name" : "HUAWEI", "process_name" : "Huawei.exe", "support_os" : "Windows", "version" : "1.0.0.1", "product_version" : "1.0.0.1" }, "path_rule" : { "path" : "D:\\\\tmp" } }, "rule_source" : "string", "create_time" : "2024-12-25T07:03:30.065Z", "update_time" : "2024-12-25T07:03:30.065Z" }

响应参数 状态码：200 表7 响应Body参数 参数 参数类型 描述 id String 规则ID。 name String 规则名称。 description String 规则描述。 rule Rule object 规则信息。 rule_source String 规则来源。 create_time String 创建时间。 update_time String 更新时间。 表8 Rule 参数 参数类型 描述 scope String 规则范围： PRODUCT - 产品 PATH - 路径 product_rule ProductRule object 产品规则信息,进程名称、产品名称、发布者的各项都需要匹配，为空或者表示任意匹配。 例如： 发布者： 产品名称：Huawei 进程名称：* 只要产品名称是Huawei的就可以认为是匹配的。 path_rule PathRule object 路径规则信息,限制对应路径及子路径 表9 ProductRule 参数 参数类型 描述 identify_condition String 识别条件。 publisher String 发布者名称： 名称允许可见字符或空格，不可为全空格。 长度0~1024个字符。 为空或者*号表示任意匹配。 product_name String 产品名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 process_name String 进程名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 support_os String 操作系统类型，仅内置规则存在该字段。 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 version String 版本号： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 product_version String 产品版本号： 允许可见字符。 长度0~128个字符。 表10 PathRule 参数 参数类型 描述 path String 完整路径： 名称允许可见字符或空格，不可为全空格。 长度0~512个字符。 为空或者*号表示任意匹配。 状态码：400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 规则名称： 名称允许可见字符或空格，不可为全空格。 长度1~64个字符。 rule 是 Rule object 规则信息。 表4 Rule 参数 是否必选 参数类型 描述 scope 是 String 规则范围： PRODUCT - 产品 PATH - 路径 product_rule 否 ProductRule object 产品规则信息,进程名称、产品名称、发布者的各项都需要匹配，为空或者表示任意匹配。 例如： 发布者： 产品名称：Huawei 进程名称：* 只要产品名称是Huawei的就可以认为是匹配的。 path_rule 否 PathRule object 路径规则信息,限制对应路径及子路径 表5 ProductRule 参数 是否必选 参数类型 描述 identify_condition 否 String 识别条件。 publisher 否 String 发布者名称： 名称允许可见字符或空格，不可为全空格。 长度0~1024个字符。 为空或者*号表示任意匹配。 product_name 否 String 产品名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 process_name 否 String 进程名称： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 support_os 否 String 操作系统类型，仅内置规则存在该字段。 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 version 否 String 版本号： 名称允许可见字符或空格，不可为全空格。 长度0~128个字符。 为空或者*号表示任意匹配。 product_version 否 String 产品版本号： 允许可见字符。 长度0~128个字符。 表6 PathRule 参数 是否必选 参数类型 描述 path 否 String 完整路径： 名称允许可见字符或空格，不可为全空格。 长度0~512个字符。 为空或者*号表示任意匹配。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 发送的实体的MIME类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 template_id 否 String 邮件模板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类型，如：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 otp_ids 否 Array of strings 待解绑的otp配置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接口进行解密。

响应参数 状态码：400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：415 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应示例 状态码：200 成功响应。 { "volume_types" : [ { "resource_spec_code" : "workspace.volume.high", "volume_type" : "SAS", "volume_product_type" : "workspace", "resource_type" : "hws.resource.type.workspace.volume", "cloud_service_type" : "hws.service.type.vdi", "name" : [ { "language" : "en-us", "value" : "High IO Disk" }, { "language" : "zh-cn", "value" : "高IO磁盘" } ], "volume_type_extra_specs" : { "availability_zone" : "cn-north-5b,cn-north-5c,cn-north-5a", "sold_out_availability_zone" : "" } } ] }

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 type String 登录类型。 url String 远程登录控制台地址。 protocol String 登录协议。 状态码：default 表4 响应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参数 参数 是否必选 参数类型 描述 name 否 String 脚本名称。 type 否 String 脚本类型：POWERSHELL/BAT/SHELL。 description 否 String 描述。 content 否 String 脚本内容。 version 否 String 脚本版本。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 script_id String 脚本ID。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 appicon_store_path String 图标文件在obs桶经过cdn加速以后的地址。 状态码：400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：415 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

请求参数 表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 表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接口进行解密。 状态码：409 表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接口进行解密。

请求示例 /v2/9565be6e740941c493b38a1f46ecae6f/desktops/3ec05f83-b8a3-4c72-857f-b33f55943320/volumes { "order_id" : "string", "enterprise_project_id" : "0", "volumes" : [ { "type" : "SAS", "size" : 80, "cluster_id" : "string" } ] }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 job_id String 增加磁盘任务id。 getJobEndpoint String 云运营平台CBC获取到JobId后，会使用getJobEndpoint当做URL，调用云服务，查询获取Job结果。 maxProvisionTime Integer 在线开通最大时间。 minProvisionTime Integer 开通最小时间（云服务最快开通时长，或一般开通时长）。 periodicQueryTime Integer Job周期性查询时间，默认1分钟查询一次。 状态码：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接口进行解密。 状态码：409 表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接口进行解密。

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

响应参数 状态码：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_SUC CES S：创建桌面成功后，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接口进行解密。

响应示例 状态码：200 正常。 { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "task_type" : "START", "task_name" : "测试任务", "force_execute" : true, "scheduled_type" : "FIXED_TIME", "life_cycle_type" : "string", "day_interval" : 1, "week_list" : "1,2,7", "month_list" : "1,3,12", "date_list" : "1,2,28,L", "scheduled_date" : "2022-12-23", "scheduled_time" : "09:00:00", "expire_time" : "2022-12-31 09:00:00", "description" : "一个描述。", "extra_params" : "{ \"notify_message\": \"测试\" }", "apply_objects" : [ { "object_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "object_type" : "DESKTOP", "object_name" : "测试桌面" } ], "gray_count" : 0, "gray_desktop_ids" : [ "string" ], "gray_fail_threshold" : 0, "time_zone" : "GMT+8", "wait_time" : 0 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 items 是 Array of strings 批量唯一标识请求列表，一次请求数量区间 [1, 50]。 reserve_obs_file 否 Boolean 是否保留OBS桶文件，如果不保留删除应用时，会同时删除OBS桶文件(默认false)。 'true' - 保留OBS桶文件,不做任何操作。 'false' - 不保留OBS桶文件,删除应用时同时删除OBS桶文件。

响应参数 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。

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

响应参数 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：405 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：415 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。 状态码：503 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码，失败时返回。 error_msg String 错误描述。