查询云办公带宽的控制配置
功能介绍
查询云办公带宽的控制配置。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/bandwidths/{bandwidth_id}/control-list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
bandwidth_id |
是 |
String |
云办公带宽id。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
desktop_id |
否 |
String |
桌面id。 |
desktop_name |
否 |
String |
桌面名称。 |
user_name |
否 |
String |
桌面分配用户。 |
control_mode |
否 |
String |
控制模式,支持:
|
offset |
否 |
Integer |
用于分页查询,查询的起始记录序号,从0开始。 |
limit |
否 |
Integer |
用于分页查询,返回桌面数量限制。如果不指定,则返回所有符合条件的记录。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
control_mode |
String |
控制模式
|
control_list |
Array of ControlItem objects |
控制的桌面列表。 |
total_count |
Integer |
总数。 |
参数 |
参数类型 |
描述 |
---|---|---|
desktop_id |
String |
桌面id。 |
desktop_name |
String |
桌面名称。 |
desktop_status |
String |
桌面状态。 |
pool_id |
String |
池id。 |
attach_user_infos |
Array of AttachInstancesUserInfo objects |
桌面已分配的用户信息列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
当type字段为USER时,填写用户id;当type字段为GROUP时,填写用户组id,后端服务会校验组id是否存在; |
user_name |
String |
桌面分配对象的名称,当type类型USER时填写用户名字;当type类型GROUP时填写用户组名称。
|
user_group |
String |
桌面用户所属的用户组。
|
type |
String |
对象类型,可选值为:
|
状态码: default
参数 |
参数类型 |
描述 |
---|---|---|
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 |
默认响应。 |
错误码
请参见错误码。