Help Center/ Workspace/ API Reference/ Workspace APIs/ Network/ Modifying Workspace Bandwidth Control

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

View PDF

Modifying Workspace Bandwidth Control

Function

Modifies Workspace bandwidth control.

Debugging

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

URI

PUT /v2/{project_id}/bandwidths/{bandwidth_id}/control-list

**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
control_mode	No	String	Control method. BLACK: blacklist control WHITE: whitelist control
add_control_list	No	Array of strings	Desktops to be added.
remove_control_list	No	Array of strings	Desktops to be deleted.

Response Parameters

Status code: 204

Response to the request for modifying Workspace bandwidth control.

Status code: default

**Table 4** 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/control-list

{
  "control_mode" : "BLACK",
  "add_control_list" : [ "0e69423d4400f4a82f67c0059a1e4cc7" ]
}