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

Updated on 2026-02-10 GMT+08:00

View PDF

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

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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:bandwidth:createChangeOrder	Write	-	-	-	-

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 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 3** 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 4** Response body parameters
Parameter	Type	Description
order_id	String	Order ID, which is returned when an order is successfully placed.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.
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.