文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 用户组/ 查询用户组列表
更新时间：2024-01-11 GMT+08:00
查看PDF
分享

查询用户组列表

功能介绍

查询用户组列表，支持分页。

调试

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

URI

GET /v2/{project_id}/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

String

用于分页查询，返回用户组数量限制。如果不指定或为0，则使用默认值100，从1开始，最大100。

offset

否

String

用于分页查询，查询的起始记录序号，从0开始，默认值0，必须与limit同时使用。

keyword

否

String

用来匹配用户组的搜索关键字。例如根据组名模糊查询。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

Content-Type

是

String

发送的实体的MIME类型，如：application/json。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

满足条件的用户组总数。

user_groups

Array of UserGroupInfo objects

用户组列表。
表5 UserGroupInfo

参数

参数类型

描述

name

String

用户组名。

id

String

用户组ID。

create_time

String

用户组对应的创建时间，UTC时间：yyyy-MM-ddTHH:mm:ss.SSSZ。

description

String

用户组描述。

user_quantity

Integer

用户列表中用户数。

parent

UserGroupInfo object

用户组上级用户组。

realm_id

String

用户组域Id。

platform_type

String

用户组类型。

  • AD： AD域用户组

  • LOCAL： 本地liteAs用户组

group_dn

String

用户组专有名。

domain

String

用户组域名。

sid

String

用户组sid。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET /v2/92c84e5bce3d48d7ab5714a44901eb08/groups?limit=10&offset=20

响应示例

状态码： 200

查询用户组响应。

{
  "total_count" : 2,
  "user_groups" : [ {
    "id" : "99558194716db7d601719f9b61850042",
    "sid" : "99558194716db7d601719f9b61850042",
    "name" : "group1",
    "realm_id" : "695581943266db7a601719f9e61850058",
    "domian" : "local.com",
    "description" : "for test",
    "platform_type" : "LOCAL",
    "create_time" : "2023-02-15T02:27:05.000Z",
    "user_quantity" : 10
  }, {
    "id" : "99558194716db7d601719f9b61850000",
    "sid" : "99558194716db7d601719f9b61850000",
    "name" : "group2",
    "realm_id" : "453381943266db7a601719f9e61850044",
    "domian" : "local.com",
    "description" : "for test2",
    "platform_type" : "LOCAL",
    "create_time" : "2023-01-16T02:27:05.000Z",
    "user_quantity" : 20
  } ]
}

状态码

状态码

描述

200

查询用户组响应。

400

由于包含语法错误，当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误，具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码。

父主题： 用户组