
# 查看告警分组 - GetAlarmGroupList
#### 功能介绍
分页查询告警分组列表，支持按名称模糊搜索、按企业项目和应用类型过滤。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-apm/apm_04_0007.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-apm/apm_04_0021.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项               | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | apm：：getAdminInfo | Read | -           | -   | -  | -      |
     
  
 
#### URI
GET /v2/alarm-center/group/get-group-list
表1Query参数 
| 参数        | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| page      | 否    | Integer | **参数解释**： 分页查询的页数。 **约束限制**： 不涉及。 **取值范围**： 大于等于1的整数。 **默认取值**： 1                                                                                                                                                                                                                                                                                                                               |
| page_size | 否    | Integer | **参数解释**： 每页告警分组的个数。 **约束限制**： 不涉及。 **取值范围**： 大于等于1的整数。 **默认取值**： 10                                                                                                                                                                                                                                                                                                                            |
| keyword   | 否    | String  | **参数解释**： 模板名称，支持模糊匹配。 **约束限制**： 不涉及。 **取值范围**： 字符串。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                             |
| id        | 否    | Long    | **参数解释**： 告警分组ID。 **约束限制**： 不涉及。 **取值范围**： 大于0的整数。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                               |
| order_by  | 否    | String  | **参数解释**： 排序规则。 **约束限制**： 不涉及。 **取值范围**： 字符串。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                                    |
| eps_id    | 否    | String  | **参数解释**： 企业项目ID。 **约束限制**： 不涉及。 **取值范围**： 字符串。 **默认取值**： 不涉及。                                                                                                                                                                                                                                                                                                                                  |
| source    | 否    | String  | **参数解释**： 应用类型。 **约束限制**： 不涉及。 **取值范围**： - APM2  - TRACING  - WEB  - OTEL   **默认取值**： 不涉及 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 从IAM服务获取的用户Token。获取方式请参见：[获取Token](https://support.huaweicloud.com/api-apm/apm_api_0010.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数          | 参数类型                                                                               | 描述                                                                                                                                            |
|:---|:---|:---|
| group_vos   | Array of [AlarmCenterGroup] objects | **参数解释**： 告警分组列表。                                                                                        |
| total_count | Integer                                                                            | **参数解释**： 总记录数。 **取值范围**： 不涉及。 |
   
 表4AlarmCenterGroup 
| 参数          | 参数类型             | 描述                                                                                                                                                                                                         |
|:---|:---|:---|
| id          | Long             | **参数解释**： 告警分组ID。 **取值范围**： 不涉及。                                                            |
| name        | String           | **参数解释**： 告警分组名称。 **取值范围**： 不涉及。                                                            |
| gmt_create  | String           | **参数解释**： 创建时间。 **取值范围**： 不涉及。                                                              |
| rule_list   | Array of strings | **参数解释**： 分组下的告警规则列表。                                                                                                                                                 |
| enable      | Boolean          | **参数解释**： 是否启用。 **取值范围**： true：启用告警分组。 false：不启用告警分组。 |
| description | String           | **参数解释**： 告警分组描述。 **取值范围**： 不涉及。                                                            |
| eps_id      | String           | **参数解释**： 企业项目ID。 **取值范围**： 不涉及。                                                            |
| source      | String           | **参数解释**： 应用类型。 **取值范围**： 不涉及。                                                              |
   
#### 请求示例
```
/v2/alarm-center/group/get-group-list
```
#### 响应示例
**状态码：200**
查询告警分组成功。
```
{
  "group_vos" ： [ {
    "description" ： "",
    "id" ： 3807,
    "name" ： "alarm_group",
    "gmt_create" ： "2025-12-22 21：05：10",
    "rule_list" ： [ "alarm_rule" ],
    "enable" ： false,
    "eps_id" ： "0",
    "source" ： "APM2"
  } ],
  "total_count" ： 1
}
```
#### 状态码
| 状态码 | 描述                |
|:---|:---|
| 200 | OK                |
| 400 | Bad Request       |
| 403 | Forbidden         |
| 429 | Too Many Requests |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-apm/ErrorCode.html)。
