Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Modifying Workspace Bandwidth
Updated on 2025-07-14 GMT+08:00
View PDF
Share

Modifying Workspace Bandwidth

Function

Modifies Workspace bandwidth.

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}/update

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

Yes

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

No

Integer

Workspace bandwidth size.

enterprise_project_id

No

String

Enterprise project ID, which is 0 by default.

charge_mode

No

String

Billing mode.

  • wks_bandwidth: billed by bandwidth

  • free: free of charge but not supported for yearly/monthly billing

  • wks_traffic: billed by traffic

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: default

Table 5 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/0e69423d4400f4a82f67c0059a1e4cc8/bandwidths/0e69423d4400f4a82f67c0059a1e4cc7/update

{
  "bandwidth_size" : 1
}

Example Responses

Status code: 200

Response to the request for modifying Workspace bandwidth.

{
  "job_id" : "fa9e41e1-1221-47c3-a43c-67a1271e2093"
}

Status Codes

Status Code

Description

200

Response to the request for modifying Workspace bandwidth.

default

Default response.

Error Codes

See Error Codes.

Parent topic: Network