# 查询云办公带宽的控制配置 - ShowSubnetBandwidthControlList #### 功能介绍 查询云办公带宽的控制配置。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/Workspace/doc?api=ShowSubnetBandwidthControlList)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | workspace:bandwidth:getControlConfig | Read | - | - | - | - | #### URI GET /v2/{project_id}/bandwidths/{bandwidth_id}/control-list 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 | | bandwidth_id | 是 | String | 云办公带宽id。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | desktop_id | 否 | String | 桌面id。 | | desktop_name | 否 | String | 桌面名称。 | | user_name | 否 | String | 桌面分配用户。 | | control_mode | 否 | String | 控制模式，支持： - BLACK 黑名单 - WHITE 白名单 | | offset | 否 | Integer | 用于分页查询，查询的起始记录序号，从0开始。 | | limit | 否 | Integer | 用于分页查询，返回桌面数量限制。如果不指定，则返回所有符合条件的记录。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | control_mode | String | 控制模式 - BLACK：黑名单控制。 - WHITE：白名单控制。 | | control_list | Array of [ControlItem] objects | 控制的桌面列表。 | | total_count | Integer | 总数。 | 表4ControlItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | desktop_id | String | 桌面id。 | | desktop_name | String | 桌面名称。 | | desktop_status | String | 桌面状态。 | | pool_id | String | 池id。 | | attach_user_infos | Array of [AttachInstancesUserInfo] objects | 桌面已分配的用户信息列表。 | 表5AttachInstancesUserInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | user_id | String | 当type字段为USER时，填写用户id；当type字段为GROUP时，填写用户组id，后端服务会校验组id是否存在； | | user_name | String | 桌面分配对象的名称，当type类型USER时填写用户名字；当type类型GROUP时填写用户组名称。 - 当type类型USER时：桌面所属的用户，当桌面分配成功后此用户可以登录该桌面。只允许输入大写字母、小写字母、数字、中划线（-）和下划线（_）。域类型为LITE_AD时，使用小写字母或者大写字母开头，长度范围为\[1-20\]。当域类型为LOCAL_AD时，用户名可以使用小写字母或者大写字母或者数字开头，长度范围为\[1-64\]。Windows桌面用户最长支持20个字符，Linux桌面用户最长支持64个字符。后端服务会校验用户名是否存在，并且用户名不能与机器名重复。 - 当type类型GROUP时：只能为中文、字母、数字及特殊符号-_。 | | domain | String | 用户所属域。 | | user_group | String | 桌面用户所属的用户组。 - sudo：Linux管理员组。 - default：Linux默认用户组。 - administrators：Windows管理员组。管理员拥有对该桌面的完全访问权，可以做任何需要的更改（禁用操作除外）。 - users：Windows标准用户组。标准用户可以使用大多数软件，并可以更改不影响其他用户的系统设置。 | | type | String | 对象类型，可选值为，默认值为USER： - USER：用户。 - GROUP：用户组。 | **状态码：default** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码，失败时返回。 | | error_msg | String | 错误描述。 | | error_detail | String | 错误详情。 | | encoded_authorization_message | String | 加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 | #### 请求示例 无 #### 响应示例 **状态码：200** 查询云办公带宽的控制配置响应。 ``` { "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 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询云办公带宽的控制配置响应。 | | default | 默认响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode.html)。