# 包周期桌面池批量变更下单 - CreateDesktopPoolChangeOrder #### 功能介绍 包周期桌面池批量变更下单。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=CreateDesktopPoolChangeOrder)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:orders:change | Write | - | workspace:ChangeOrderType | - | - ims:images:list - bss:order:update | #### URI POST /v2/{project_id}/desktop-pool/periodic/change/order 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | #### 请求参数 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | 下单类型。 - ADD_VOLUME：增加磁盘 - EXTEND_VOLUME：扩容磁盘 - RESIZE：变更规格 - CHANGE_IMAGE：切换镜像 - ADD_SUB_RESOURCES：购买桌面协同资源 - DELETE_SUB_RESOURCES：退订桌面协同资源 | | agency_urn | 否 | String | 授权给Billing服务的委托URN。使用RAM共享密钥创建包周期云桌面或添加包周期磁盘、重建系统时，需要传入该字段。 | | add_volume_param | 否 | [EstimateAddVolumeRequestBody] object | 包周期桌面池添加磁盘、切换镜像询价请求体。 | | extend_volume_param | 否 | [EstimateExtendVolumeRequestBody] object | 包周期扩容磁盘询价请求体。 | | resize_param | 否 | [CreateResizeOrderRequestBody] object | 包周期变更规格询价请求体。 | | change_image_param | 否 | [CreateChangeImageOrderRequestBody] object | 包周期重建系统盘询价请求体。 | | add_sub_resources_param | 否 | [EstimateAddSubResourcesRequestBody] object | 包周期新增附属资源询价请求体。 | | delete_sub_resources_param | 否 | [CreateDeleteSubResourcesOrderRequestBody] object | 包周期删除附属资源询价请求体。 | 表3EstimateAddVolumeRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | desktop_pool_disk_id | 否 | String | 需要添加的的桌面池磁盘ID，修复不一致磁盘必传。 | | volume_type | 是 | String | 新增磁盘类型。 | | volume_size | 是 | Integer | 新增磁盘大小。 | | iops | 否 | Integer | iops，云硬盘每秒进行读写的操作次数。 | | throughput | 否 | Integer | 吞吐量，云硬盘每秒成功传送的数据量，即读取和写入的数据量。 | | kms_id | 否 | String | 如果磁盘加密，传递的密钥Id。 | 表4EstimateExtendVolumeRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | desktop_pool_disk_id | 是 | String | 需要扩容的桌面池磁盘ID。 | | new_size | 是 | Integer | 扩容后的磁盘大小，整池操作时必须大于当前桌面池模板值。 | 表5CreateResizeOrderRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | product_id | 是 | String | 目标规格产品ID。 | | mode | 否 | String | 是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP，如果桌面处于开机状态，会先关机再变更规格。 | 表6CreateChangeImageOrderRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 桌面id | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | image_spec_code | 否 | String | 云市场镜像的specCode，即将停用。image_spec_code与image_id同时存在时取image_id的值，两者不可同时为空。 | | image_id | 否 | String | 云市场镜像ID，建议使用image_id。 | | image_type | 否 | String | 镜像类型。仅重建系统盘/更换镜像使用 - private：私有镜像。 - gold：公共镜像。 | | delay_time | 否 | Integer | 立即重建时给用户预留的保存数据的时间（单位：分钟）。 | | message | 否 | String | 下发重建系统盘任务时，给用户发送的提示信息。 | | encrypt_type | 否 | String | 加密类型。 - KEEP：保持原有加密状态 - UNENCRYPTED：不加密 - ENCRYPTED：加密（需同步上传kms_id） | | kms_id | 否 | String | 密钥ID，encrypt_type为ENCRYPTED时必传。 | 表7EstimateAddSubResourcesRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | sub_resource_sku | 是 | String | 新增附属资源SKU码。 | 表8CreateDeleteSubResourcesOrderRequestBody | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_pool_id | 否 | String | 桌面池ID。当desktop_pool_id与desktop_ids同时存在时，取desktop_ids的值，两者不可同时为空。 | | desktop_ids | 否 | Array of strings | 包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。 | | promotion_plan_id | 否 | String | 促销计划ID。 | | handle_type | 否 | String | 处理类型 - ONLY_FOR_EXPAND：仅对新扩容桌面生效 - FOR_EXPAND_AND_IDLE：对新扩容桌面与空闲桌面生效 - FOR_EXPAND_AND_ALL：对新扩容桌面与已有全部桌面生效 | | sub_resource_type | 是 | String | 待删除附属资源类型：DESKTOP_SHARER(桌面协同资源)。 | #### 响应参数 **状态码：200** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | orders | Array of [OrderV5] objects | 批量生成订单结果。 | 表10OrderV5 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | order_id | String | 订单id。 | | job_id | String | jobId。 | | order_status | Integer | 订单状态:0:初始化; 1:待审核; 2:待退款; 3:处理中; 4:已取消; 5:已完成; 6:待支付; 7:补偿中; 8:待审批; 9:待确认; 10:待发货; 11:待收货; 12:待上门取货; 13:换新中; 14:待商家收货。 | | result | String | 结果，SUCCESS:成功； FAIL：失败。 | | result_code | String | result=FAIL时，必填，表示该订单失败原因。 | | result_msg | String | 失败信息，和result_code结对出现。 | **状态码：400** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：409** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | **状态码：500** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 ``` { "type" : "ADD_VOLUME", "add_volume_param" : { "desktop_pool_id" : "b046ac8e-0994-4c09-a8a8-bd989d218120", "volume_type" : "SAS", "volume_size" : 10 } } ``` #### 响应示例 **状态码：200** 包周期桌面池批量变更下单响应体。 ``` { "orders" : [ { "order_id" : "CS25052414519W9OP", "order_status" : 6 } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 包周期桌面池批量变更下单响应体。 | | 400 | 由于包含语法错误，当前请求无法被服务器理解。 | | 409 | 操作冲突。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。