云桌面 WORKSPACE-包周期桌面池批量变更下单:请求参数

时间:2024-12-27 15:06:33

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型。

表3 请求Body参数

参数

是否必选

参数类型

描述

type

String

下单类型。

  • ADD_VOLUME:增加磁盘

  • EXTEND_VOLUME:扩容磁盘

  • RESIZE:变更规格

  • CHANGE_IMAGE:切换镜像

  • ADD_SUB_RESOUR CES :购买桌面协同资源

  • DELETE_SUB_RESOURCES:退订桌面协同资源

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

包周期删除附属资源询价请求体。

表4 EstimateAddVolumeRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

volume_type

String

新增磁盘类型。

volume_size

Integer

新增磁盘大小。

表5 EstimateExtendVolumeRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

desktop_pool_disk_id

String

需要扩容的桌面池磁盘ID。

new_size

Integer

扩容后的磁盘大小。

表6 CreateResizeOrderRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

product_id

String

目标规格产品ID。

mode

String

是否支持开机状态下执行变更规格操作。固定传值STOP_DESKTOP,如果桌面处于开机状态,会先关机再变更规格。

表7 CreateChangeImageOrderRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

image_spec_code

String

云市场镜像的specCode,即将停用。image_spec_code与image_id同时存在时取image_id的值,两者不可同时为空。

image_id

String

云市场镜像ID,建议使用image_id。

delay_time

Integer

立即重建时给用户预留的保存数据的时间(单位:分钟)。

message

String

下发重建系统盘任务时,给用户发送的提示信息。

表8 EstimateAddSubResourcesRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

sub_resource_sku

String

新增附属资源SKU码。

表9 CreateDeleteSubResourcesOrderRequestBody

参数

是否必选

参数类型

描述

desktop_pool_id

String

桌面池ID。当desktop_pool_id与desktop_ids同时存在时,取desktop_ids的值,两者不可同时为空。

desktop_ids

Array of strings

包周期桌面ID列表。 不可同时存在普通桌面和池桌面ID。

promotion_plan_id

String

促销计划ID。

sub_resource_type

String

待删除附属资源类型:DESKTOP_SHARER(桌面协同资源)。

support.huaweicloud.com/api-workspace/CreateDesktopPoolChangeOrder.html