文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 订单/ 包周期桌面批量变更下单
更新时间：2024-12-12 GMT+08:00
查看PDF
分享

包周期桌面批量变更下单

功能介绍

包周期桌面批量变更下单

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/periodic/change/batch-order

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

请求参数

表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_RESOURCES：购买桌面协同资源

  • 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(桌面协同资源)。

响应参数

状态码： 200

表10 响应Body参数

参数

参数类型

描述

orders

Array of OrderV5 objects

批量生成订单结果
表11 OrderV5

参数

参数类型

描述

order_id

String

订单id

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

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 409

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码： 500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

{
  "type" : "CHANGE_IMAGE",
  "change_image_param" : {
    "desktop_ids" : [ "055f1460-d95f-4e06-afa5-d53b6cf3f44c,", "066f1460-d95f-4e06-afa5-d53b6cf33444" ],
    "image_id" : "f1a0fd3fe04530f5b4af0b1bb62476f9"
  }
}

响应示例

无

状态码

状态码

描述

200

包周期桌面批量下单响应体

400

由于包含语法错误，当前请求无法被服务器理解。

409

操作冲突。

500

服务器内部错误

错误码

请参见错误码。

父主题： 订单

相关文档