更新时间:2025-07-09 GMT+08:00

创建变更订单

功能介绍

变更规格、扩容磁盘。

调试

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

URI

POST /v2/{project_id}/periodic/{desktop_id}/change/order

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

desktop_id

String

桌面id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

Content-Type

String

发送的实体的MIME类型。

表3 请求Body参数

参数

是否必选

参数类型

描述

type

String

类型 resizeDesktops(变更规格)、expandVolumes(扩容磁盘)。

period_type

Integer

周期类型,2:包月;3:包年。

period_num

Integer

周期数。

resize_product_id

String

变更后规格产品ID,当是resizeDesktops,必传。

expand_volume_id

String

扩容的云硬盘的ID,当是expandVolumes,必传。

expand_new_size

Integer

扩容后云硬盘的总大小,当是expandVolumes,必传。范围10-32760,大小为10的倍数。

new_quantity

Integer

专享主机变更桌面数后桌面路数的总大小,当是jobType是resizeExclusiveLites,必传。

exclusive_lites_product_id

String

专享主机桌面数的productId,当是resizeExclusiveLites,必传。

enterprise_project_id

String

企业项目ID。

extend_param

OrderExtendParam object

订单的扩展参数。

表4 OrderExtendParam

参数

是否必选

参数类型

描述

is_auto_pay

String

是否自动付款。true:自动支付; false:不自动支付;默认false。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

order_id

String

订单号,下单成功时返回订单ID。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码:409

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

error_detail

String

错误详情。

encoded_authorization_message

String

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

请求示例

/v2/0bec5db98280d2d02fd6c00c2de791ce/periodic/f8f7fe7a-9043-44ff-815e-ad20fc779d18/change/order

{
  "type" : "resizeDesktops",
  "resize_product_id" : "workspacehost.k.large4"
}

响应示例

状态码:200

创建订单相应体。

{
  "order_id" : "CS2108102036B2CAI"
}

状态码

状态码

描述

200

创建订单相应体。

400

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

409

操作冲突。

500

服务器内部错误。

错误码

请参见错误码