查询用户组列表

1. 接口说明

用于查询用户组列表。

版本支持

本文接口契约适用于 CAN 发布版本：V2.3.0+。

2. 接口URL

POST http://{anymetrics_host:anymetrics_port}/anymetrics/api/v1/userGroup/list

anymetrics_host:anymetrics_port 获取方式请参考：调用方式

3. 公共请求参数（HEADERS）

参数	类型	是否必选	描述
tenant-id	String	是	租户 ID，用于标识资源所属租户
auth-type	String	是	认证方式。支持 UID、TOKEN、ACCOUNT、APIKEY
auth-value	String	是	与 auth-type 对应的认证值

3.1 公共参数获取方式

tenant-id 可在 Aloudata CAN 顶部导航栏选择指标应用，左边菜单栏选择 API 集成，在 API 集成界面获取；auth-value 请按 auth-type 填写对应认证值。

3.2. 请求体参数：

参数	类型	是否必选	描述
keyword	String	否	搜索关键字
groupIdentityType	String	当 groupIds 不为空时必填	用户组标识类型（USER_GROUP_ID 或 USER_GROUP_CODE）
groupIds	Array	否	用户组 ID 或 code 列表
pageNumber	Integer	是	页码
pageSize	Integer	是	每页大小

4. 请求示例：

curl --location 'http://localhost:8083/anymetrics/api/v1/userGroup/list' \
--header 'tenant-id: tn_21571046' \
--header 'auth-value: authority_test' \
--header 'auth-type: ACCOUNT' \
--header 'Content-Type: application/json' \
--data '{
  "keyword": "销售",
  "groupIdentityType": "USER_GROUP_ID",
  "groupIds": ["g_1001", "g_1002"],
  "pageNumber": 1,
  "pageSize": 20
}'

5. 返回示例：

{
  "data": [
    {
      "groupId": "g_1001",
      "name": "华东销售组",
      "description": "华东区域销售人员",
      "parentGroupId": "g_root",
      "code": "EAST_SALES"
    }
  ],
  "total": 120,
  "pageNumber": 1,
  "pageSize": 20
}