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

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

View PDF

Querying Workspace Bandwidth Control

Function

Queries 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

GET /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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
desktop_id	No	String	Desktop ID.
desktop_name	No	String	Desktop name.
user_name	No	String	Users to whom desktops are assigned.
control_mode	No	String	Control method. Options: BLACK: blacklist WHITE: whitelist
offset	No	Integer	Where the pagination query starts. The value starts from 0.
limit	No	Integer	Limits the quantity of returned desktops in pagination query. If this parameter is not specified, all records that meet the search criteria are returned.

Request Parameters

**Table 3** 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
control_mode	String	Control method. BLACK: blacklist control WHITE: whitelist control
control_list	Array of ControlItem objects	Desktops in control.
total_count	Integer	Total number.

**Table 5** ControlItem
Parameter	Type	Description
desktop_id	String	Desktop ID.
desktop_name	String	Desktop name.
desktop_status	String	Desktop status.
pool_id	String	Pool ID.
attach_user_infos	Array of AttachInstancesUserInfo objects	List of users to whom desktops have been assigned.

**Table 6** AttachInstancesUserInfo
Parameter	Type	Description
user_id	String	If type is set to USER, enter the user ID. If type is set to GROUP, enter the user group ID. The backend service checks whether the group ID exists.
user_name	String	Name of the object assigned with a desktop. If type is set to USER, enter the username. If type is set to GROUP, enter the user group name. If type is set to USER, the value is the username of the desktop user. After the desktop is assigned, the user can log in to the desktop. Only letters, digits, hyphens (-), and underscores (_) are allowed. When the domain type is LITE_AD, the value contains 1 to 20 characters starting with a letter. When the domain type is LOCAL_AD, the value contains 1 to 64 characters starting with a letter or digit. A Windows desktop username can contain a maximum of 20 characters, and a Linux desktop username can contain a maximum of 64 characters. The backend service checks whether the username exists. The username cannot be the same as the desktop name. If type is set to GROUP, the value can contain only letters, digits, hyphens (-), and underscores (_).
user_group	String	Specifies the user group to which the desktop user belongs. sudo: Linux administrator group. default: default Linux user group. administrators: Windows administrator group. Administrators have full access to the desktop and can make any required changes except for forbidden operations. users: standard Windows user group. Standard users can use most software programs and change system settings that do not affect other users.
type	String	Object type. Options: USER: user GROUP: user group

Status code: default

**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.

Example Requests

None

Example Responses

Status code: 200

Response to the request for querying Workspace bandwidth control.

{
  "control_mode" : "string",
  "control_list" : [ {
    "desktop_id" : "string",
    "desktop_name" : "string",
    "desktop_status" : "string",
    "pool_id" : "string",
    "attach_user_infos" : [ {
      "user_id" : "string",
      "user_name" : "string",
      "user_group" : "string",
      "type" : "USER"
    } ]
  } ],
  "total_count" : 0
}