# 重建桌面 - BatchRebuildDesktopsSystemDisk #### 功能介绍 批量重建桌面系统盘。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=BatchRebuildDesktopsSystemDisk)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:desktops:rebuild | Write | desktop \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - vpc:ports:get - ims:images:get - ims:images:list - ims:images:share - ims:images:updateMemberStatus - ims:images:deleteMember - ims:images:addMember | #### URI POST /v2/{project_id}/desktops/rebuild 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_ids | 是 | Array of strings | 计算机id列表。 | | image_type | 是 | String | 镜像类型 - 公共镜像：gold - 私有镜像：private - 市场镜像：market | | image_id | 是 | String | 模板ID。 | | encrypt_type | 否 | String | 加密类型。 - KEEP：保持原有加密状态 - UNENCRYPTED：不加密 - ENCRYPTED：加密（需同步上传kms_id） | | kms_id | 否 | String | 密钥ID，encrypt_type为ENCRYPTED时必传。 | | os_type | 否 | String | os类型。 | | delay_time | 否 | Integer | 立即重建时给用户预留的保存数据的时间（单位：分钟）。 | | message | 否 | String | 下发重建系统盘任务时，给用户发送的提示信息。 | | order_id | 否 | String | 订单ID，包周期桌面重建系统盘，涉及收费镜像时需传。 | | enterprise_project_id | 否 | String | 企业项目ID，默认"0。" | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | | job_id | String | 重建系统盘总任务id。 | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：401** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：403** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：404** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：409** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` { "desktop_ids" : [ "string" ], "image_type" : "string", "image_id" : "string", "os_type" : "string", "delay_time" : 2147483647, "message" : "string", "order_id" : "string", "enterprise_project_id" : "0" } ``` #### 响应示例 **状态码：200** 正常。 ``` { "job_id" : "string" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 正常。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 401 | 鉴权失败。 | | 403 | 没有操作权限。 | | 404 | 找不到资源。 | | 409 | 操作冲突。 | | 500 | 服务内部错误，具体返回错误码请参见错误码说明。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。