创建变更订单 - CreateChangeOrder
功能介绍
变更规格、扩容磁盘。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
workspace:orders:change
Write
-
workspace:ChangeOrderType
-
- ims:images:list
- bss:order:update
URI
POST /v2/{project_id}/periodic/{desktop_id}/change/order
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
desktop_id |
是 |
String |
桌面id。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
订单的扩展参数。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
order_id |
String |
订单号，下单成功时返回订单ID。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：409
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
服务器内部错误。 |
错误码
请参见错误码。
