更新时间:2026-08-19 GMT+08:00
分享

查看告警策略列表 - GetAlarmRuleList

功能介绍

分页查询告警策略列表,支持按业务、应用、环境、标签等多维度过滤

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm::getAdminInfo

    Read

    -

    -

    -

    -

URI

POST /v2/alarm-center/rule/get-alarm-rule-list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

page

Integer

参数解释

页数。

约束限制

不涉及。

取值范围

大于等于1的整数。

默认取值

不涉及

page_size

Integer

参数解释

每页大小。

约束限制

不涉及。

取值范围

大于等于1的整数。

默认取值

不涉及

business_ids

Array of longs

参数解释

业务ID列表,用于按业务过滤。

约束限制

不涉及。

app_ids

Array of longs

参数解释

应用ID列表,用于按应用过滤。

约束限制

不涉及。

env_ids

Array of longs

参数解释

环境ID列表,用于按环境过滤。

约束限制

不涉及。

env_tag_ids

Array of longs

参数解释

环境标签ID列表,用于按环境标签过滤。

约束限制

不涉及。

keyword

String

参数解释

关键字搜索。

约束限制

不涉及。

取值范围

字符串。

默认取值

不涉及

name

String

参数解释

告警策略名称。

约束限制

不涉及。

取值范围

字符串。

默认取值

不涉及

alarm_group_id

Long

参数解释

告警分组ID,用于按分组过滤。

约束限制

不涉及。

取值范围

大于0的整数。

默认取值

不涉及

level

String

参数解释

告警级别。

约束限制

不涉及。

取值范围

COMMON、CRITICAL。

默认取值

不涉及

order_by

String

参数解释

排序规则。

约束限制

不涉及。

取值范围

  • level asc
  • level desc
  • gmt_create asc
  • gmt_create desc

默认取值

不涉及

响应参数

状态码: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

参数解释

告警级别。

取值范围

不涉及

enable

Boolean

参数解释

是否启用。

取值范围

不涉及

eps_id

String

参数解释

企业项目ID。

取值范围

不涉及

source

String

参数解释

应用类型。

取值范围

不涉及

请求示例

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

{
  "page" : 1,
  "page_size" : 10
}

响应示例

状态码:200

查看告警策略列表成功。

{
  "rule_vos" : [ {
    "id" : 12649,
    "name" : "alarm_rule",
    "gmt_create" : "2026-07-10 18:24:45",
    "expression" : "(errorCount>1)",
    "context" : "test",
    "level" : "COMMON",
    "enable" : true,
    "eps_id" : "0",
    "source" : "APM2"
  } ],
  "total_count" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

403

Forbidden

429

Too Many Requests

错误码

请参见错误码

相关文档