On this page

Function
Debugging
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ Workspace/ API Reference/ Workspace APIs/ Order/ Placing an Order on Changing the Bandwidth of Yearly/Monthly Workspace

Placing an Order on Changing the Bandwidth of Yearly/Monthly Workspace

Updated on 2025-07-14 GMT+08:00

View PDF

Function

Places an order on changing the bandwidth of yearly/monthly Workspace.

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}/bandwidths/{bandwidth_id}/periodic/change/order

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
bandwidth_id	Yes	String	Workspace bandwidth 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
bandwidth_name	No	String	Workspace bandwidth name.
bandwidth_size	Yes	String	Workspace bandwidth to be changed.
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

{
  "bandwidth_name" : "string",
  "bandwidth_size" : "string",
  "enterprise_project_id" : "string",
  "extend_param" : {
    "is_auto_pay" : "string"
  }
}

Example Responses

Status code: 200

Response body for placing an order on changing the bandwidth of yearly/monthly Workspace.

{
  "order_id" : "string"
}

Status Codes


Status Code	Description
200	Response body for placing an order on changing the bandwidth of yearly/monthly Workspace.
400	The request cannot be understood by the server due to malformed syntax.
409	Operation conflict.
500	Internal server error.