文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 网络/ 查询云办公带宽的控制配置
更新时间:2024-12-27 GMT+08:00
分享

查询云办公带宽的控制配置

功能介绍

查询云办公带宽的控制配置。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

bandwidth_id

String

云办公带宽id。

表2 Query参数

参数

是否必选

参数类型

描述

desktop_id

String

桌面id。

desktop_name

String

桌面名称。

user_name

String

桌面分配用户。

control_mode

String

控制模式,支持:

  • BLACK 黑名单

  • WHITE 白名单

offset

Integer

用于分页查询,查询的起始记录序号,从0开始。

limit

Integer

用于分页查询,返回桌面数量限制。如果不指定,则返回所有符合条件的记录。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

control_mode

String

控制模式

  • BLACK:黑名单控制。

  • WHITE:白名单控制。

control_list

Array of ControlItem objects

控制的桌面列表。

total_count

Integer

总数。

表5 ControlItem

参数

参数类型

描述

desktop_id

String

桌面id。

desktop_name

String

桌面名称。

desktop_status

String

桌面状态。

pool_id

String

池id。

attach_user_infos

Array of AttachInstancesUserInfo objects

桌面已分配的用户信息列表。

表6 AttachInstancesUserInfo

参数

参数类型

描述

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时:只能为中文、字母、数字及特殊符号-_。

user_group

String

桌面用户所属的用户组。

  • sudo:Linux管理员组。

  • default:Linux默认用户组。

  • administrators:Windows管理员组。管理员拥有对该桌面的完全访问权,可以做任何需要的更改(禁用操作除外)。

  • users:Windows标准用户组。标准用户可以使用大多数软件,并可以更改不影响其他用户的系统设置。

type

String

对象类型,可选值为:

  • USER:用户。

  • GROUP:用户组。

状态码: default

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

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

默认响应。

错误码

请参见错误码

相关文档