Changing an Order

Function

Changes specifications, expands disk capacity.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
desktop_id	Yes	String	Desktop ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
type	Yes	String	Type. Options: resizeDesktops (specification change), expandVolumes (disk capacity expansion).
period_type	No	Integer	Period type. 2 indicates monthly and 3 indicates yearly.
period_num	No	Integer	Number of periods.
resize_product_id	No	String	ID of the product after the change. This parameter is mandatory when type is set to resizeDesktops.
expand_volume_id	No	String	ID of the EVS disk to be expanded. This parameter is mandatory when type is set to expandVolumes.
expand_new_size	No	Integer	Total size of the EVS disk after capacity expansion. This parameter is mandatory when type is set to expandVolumes. The value ranges from 10 to 32,760 and must be a multiple of 10.
new_quantity	No	Integer	Total number of desktops running on an exclusive host after the number of desktops is changed. This parameter is mandatory when jobType is set to resizeExclusiveLites.
exclusive_lites_product_id	No	String	Product ID of a desktop running on an exclusive host. This parameter is mandatory when jobType is set to resizeExclusiveLites.
enterprise_project_id	No	String	Enterprise project ID.
extend_param	No	OrderExtendParam object	Extended parameter of the order.

**Table 4** OrderExtendParam
Parameter	Mandatory	Type	Description
is_auto_pay	No	String	Whether to automatically pay. true: yes; false (default value): no

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
order_id	String	Order ID, which is returned when an order is successfully placed.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 409

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

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

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

Example Responses

Status code: 200

Response body for changing an order.

{
  "order_id" : "CS2108102036B2CAI"
}

Status Codes

Status Code	Description
200	Response body for changing an order.
400	The request cannot be understood by the server due to malformed syntax.
409	Operation conflict.
500	Internal server error.