文档首页/ 应用性能管理 APM/ API参考（2.0）/ API/ 告警中心管理/ 告警分组管理/ 查看分组下的告警规则 - GetGroupRuleList
更新时间：2026-08-19 GMT+08:00
查看PDF
分享

查看分组下的告警规则 - GetGroupRuleList

功能介绍

分页查询指定告警分组下的告警规则列表。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    apm：：getAdminInfo

    Read

    -

    -

    -

    -

URI

GET /v2/alarm-center/group/get-rule-list

表1 Query参数

参数

是否必选

参数类型

描述

page

是

Integer

参数解释：

分页查询的页数。

约束限制：

不涉及。

取值范围：

大于等于1的整数。

默认取值：

1

page_size

是

Integer

参数解释：

每页告警规则个数。

约束限制：

不涉及。

取值范围：

大于等于1的整数。

默认取值：

10

groupId

是

Long

参数解释：

告警分组ID。

约束限制：

不涉及。

取值范围：

大于0的整数。

默认取值：

不涉及。

keyword

否

String

参数解释：

告警规则名称，支持模糊匹配。

约束限制：

不涉及。

取值范围：

字符串。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。获取方式请参见：获取Token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

rule_vos

Array of AlarmCenterRuleVO objects

参数解释：

告警规则列表。

total_count

Integer

参数解释：

总记录数。

取值范围：

不涉及。
表4 AlarmCenterRuleVO

参数

参数类型

描述

id

Long

参数解释：

告警规则ID。

取值范围：

不涉及。

name

String

参数解释：

告警规则名称。

取值范围：

不涉及。

group_id

Long

参数解释：

所属告警分组ID。

取值范围：

不涉及。

group_name

String

参数解释：

所属告警分组名称。

取值范围：

不涉及。

gmt_create

String

参数解释：

创建时间。

取值范围：

不涉及。

gmt_create_timestamp

Long

参数解释：

创建时间戳（毫秒）。

取值范围：

不涉及。

expression

String

参数解释：

告警表达式。

取值范围：

不涉及。

context

String

参数解释：

通知内容。

取值范围：

不涉及。

level

String

参数解释：

告警级别。

取值范围：

  • COMMON：轻微。
  • CRITICAL：严重。

enable

Boolean

参数解释：

是否启用告警规则。

取值范围：

true：启用告警规则。

false：不启用告警规则。

eps_id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

source

String

参数解释：

应用类型。

取值范围：

不涉及。

请求示例

/v2/alarm-center/group/get-rule-list?page=1&page_size=10&groupId=3811&keyword

响应示例

状态码：200

OK

{
  "rule_vos" ： [ {
    "id" ： 12191,
    "name" ： "alarm-rule",
    "group_id" ： 3811,
    "group_name" ： "alarm-group",
    "gmt_create" ： "2025-12-22 22：10：58",
    "gmt_create_timestamp" ： 1766412658000,
    "expression" ： "(cpuRatio>0)",
    "context" ： "${df}",
    "level" ： "COMMON",
    "enable" ： false,
    "eps_id" ： "0",
    "source" ： "APM2"
  } ],
  "total_count" ： 1
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

错误码

请参见错误码。

父主题： 告警分组管理

相关文档