# 查询用户组列表 - KeystoneListGroups
#### 功能介绍
该接口可以用于++[管理员](https://support.huaweicloud.com/usermanual-iam/iam_01_0001.html)++ 查询用户组列表。
该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：[地区和终端节点](https://developer.huaweicloud.com/endpoint?IAM)。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IAM/doc?api=KeystoneListGroups)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-iam/iam_19_0001.html)。
#### URI
GET /v3/groups
表1Query参数 
| 参数      | 是否必选 | 参数类型    | 描述                                                                                                                    |
|:---|:---|:---|:---|
| domain_id | 否    | String | 用户组所属账号ID，获取方式请参见：[获取账号、IAM用户、项目、用户组、区域、委托的名称和ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。        |
| name   | 否   | String | 用户组名，长度1\~128字符之间，获取方式请参见：[获取账号、IAM用户、项目、用户组、区域、委托的名称和ID](https://support.huaweicloud.com/api-iam/iam_17_0002.html)。 |
| page                           | 否                          | Integer                       | 分页查询时数据的页数，查询值最小为1。需要与per_page同时存在。                                                                                                        |
| per_page                        | 否                          | Integer                       | 分页查询时每页的数据个数，取值范围为\[1,5000\]。需要与page同时存在。                                                                                                     |
   
#### 请求参数
表2请求Header参数 
| 参数            | 是否必选 | 参数类型    | 描述                                                                                                       |
|:---|:---|:---|:---|
| Content-Type | 是     | String  | 该字段内容填为"application/json;charset=utf8"                                                                  |
| X-Auth-Token   | 是    | String | 访问令牌，承载用户的身份、权限等信息。 token所需权限请参见[授权项](https://support.huaweicloud.com/api-iam/iam_19_0001.html)。 |
   
#### 响应参数
表3响应Body参数 
| 参数                                                                        | 参数类型            | 描述        |
|:---|:---|:---|
| total_number                                                                                      | Integer                                  | 满足查询条件的用户组总数。                      |
| [groups] | Array of objects | 用户组信息列表。 |
| [links]          | Object          | 资源链接信息。  |
   
 表4groups 
| 参数                                                                              | 参数类型     | 描述             |
|:---|:---|:---|
| description                                                                    | String    | 用户组描述信息。      |
| id                                                                             | String     | 用户组ID。       |
| domain_id                                                                      | String | 用户组所属账号ID。   |
| name                                                                            | String  | 用户组名。           |
| [links] | Object   | 用户组的资源链接信息。 |
| create_time                                                                  | Long    | 用户组创建时间。      |
   
 表5groups.links 
| 参数     | 参数类型    | 描述                     |
|:---|:---|:---|
| self     | String | 资源链接地址。              |
| previous | String | 前一邻接资源链接地址，不存在时为null。 |
| next      | String  | 后一邻接资源链接地址，不存在时为null。 |
   
 表6links 
| 参数        | 参数类型     | 描述                   |
|:---|:---|:---|
| self      | String  | 资源链接地址。             |
| previous | String   | 前一邻接资源链接地址，不存在时为null。 |
| next   | String | 后一邻接资源链接地址，不存在时为null。  |
   
#### 请求示例
查询用户组列表。
```
GET https://iam.myhuaweicloud.com/v3/groups
```
#### 响应示例
**状态码为 200 时:**
请求成功。
```
{
    "groups": [
        {
            "domain_id": "d78cbac186b744899480f25bd02...",
            "create_time": 1536293929624,
            "name": "IAMGroupA",
            "description": "IAMDescription",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/groups/5b050baea9db472c88cbae67..."
            },
            "id": "5b050baea9db472c88cbae6..."
        },
        {
            "domain_id": "d78cbac186b744899480f25...",
            "create_time": 1578107542861,
            "name": "IAMGroupB",
            "description": "IAMDescription",
            "links": {
                "next": null,
                "previous": null,
                "self": "https://iam.myhuaweicloud.com/v3/groups/07609e7eb200250a3f7dc003cb7a4e2d"
            },
            "id": "07609e7eb200250a3f7dc003cb..."
        }
    ],
    "links": {
        "next": null,
        "previous": null,
        "self": "https://iam.myhuaweicloud.com/v3/groups"
    }
}
```
#### 返回值
| 返回值   | 描述      |
|:---|:---|
| 200    | 请求成功。  |
| 400 | 参数无效。   |
| 401  | 认证失败。   |
| 403  | 没有操作权限。 |
   
#### 错误码
无