文档首页/ 应用性能管理 APM/ API参考(2.0)/ API/ 告警管理/ 查询告警列表 - ListAlarmData
更新时间:2026-07-10 GMT+08:00
分享

查询告警列表 - ListAlarmData

功能介绍

查询系统中存在的告警。

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    apm:application:get

    Read

    -

    g:EnterpriseProjectId

    apm:apm2BusinessBusiness:get

    -

URI

POST /v1/apm2/openapi/alarm/data/get-alarm-data-list

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

x-business-id

Long

参数解释:

应用id。获取方式请参见:查询应用列表,返回参数中查找对应应用的id值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

page

Integer

参数解释:

设置查询某一页码的告警列表。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

page_size

Integer

参数解释:

每页显示的告警数量。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

region

String

参数解释:

所选区域的英文名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

app_name

String

参数解释:

组件环境名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

business_id

Long

参数解释:

应用id。获取方式请参见:查询应用列表,对应的id字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

monitor_item_id

Long

参数解释:

某个监控项id。获取方式请参见:获取监控项信息

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

String

参数解释:

告警状态 。

约束限制:

不涉及。

取值范围:

  • RECOVER:已恢复
  • ABNORMAL:异常
  • ALERT:告警中

默认取值:

不涉及。

alarm_level

String

参数解释:

告警级别 。

约束限制:

不涉及。

取值范围:

  • COMMON:轻微
  • CRITICAL:严重

默认取值:

不涉及。

keyword

String

参数解释:

搜索的关键字。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

alarm_start_time

String

参数解释:

告警开始时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

alarm_end_time

String

参数解释:

告警结束时间。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

collector_id

Integer

参数解释:

应用中各组件的采集器id。获取方式请参见:获取监控项信息中返回参数中monitor_item_list_info列表中的collector_id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

ip_address

String

参数解释:

发生告警的应用中各组件在对应环境的实例id。获取方式请参见:获取实例信息列表中返回的对应的实例id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

env_list

Array of integers

参数解释:

环境集合。

约束限制:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

alarm_data_list

Array of AlarmDataVO objects

参数解释:

告警列表。

total_count

Integer

参数解释:

产生告警的总数。

取值范围:

不涉及。

表4 AlarmDataVO

参数

参数类型

描述

id

Long

参数解释:

告警通知id。

取值范围:

不涉及。

gmt_create

String

参数解释:

告警创建时间。

取值范围:

不涉及。

gmt_create_timestamp

Long

参数解释:

告警创建时间戳。

取值范围:

不涉及。

region_alarm_event_id

Long

参数解释:

该区域产生告警的id。

取值范围:

不涉及。

business_name

String

参数解释:

应用名称。

取值范围:

不涉及。

app_name

String

参数解释:

组件名称。

取值范围:

不涉及。

version_number

Integer

参数解释:

版本。

取值范围:

不涉及。

alarm_rule_type

String

参数解释:

告警规则类别。

取值范围:

不涉及。

gmt_modify

String

参数解释:

告警修改时间。

取值范围:

不涉及。

process_unit

String

参数解释:

告警处理单元。

取值范围:

不涉及。

region

String

参数解释:

产生告警区域名称。

取值范围:

不涉及。

instance_id

Long

参数解释:

实例id。

取值范围:

不涉及。

ip_address

String

参数解释:

实例ip地址。

取值范围:

不涉及。

instance_name

String

参数解释:

实例名称。

取值范围:

不涉及。

env_id

Long

参数解释:

环境id。

取值范围:

不涉及。

business_id

Long

参数解释:

应用id。

取值范围:

不涉及。

template_id

Long

参数解释:

告警模板id。

取值范围:

不涉及。

alarm_rule_id

Long

参数解释:

告警规则id。

取值范围:

不涉及。

monitor_item_id

Long

参数解释:

监控项id。

取值范围:

不涉及。

collector_id

Integer

参数解释:

采集器id。

取值范围:

不涉及。

collector_name

String

参数解释:

采集器名称。

取值范围:

不涉及。

alarm_rule_name

String

参数解释:

告警规则名称。

取值范围:

不涉及。

alarm_rule_expression

String

参数解释:

告警表达式。

取值范围:

不涉及。

alarm_first_time

String

参数解释:

开始告警时间。

取值范围:

不涉及。

alarm_last_time

String

参数解释:

最后一次告警时间。

取值范围:

不涉及。

alarm_level

String

参数解释:

告警级别。

取值范围:

不涉及。

restrain_key

String

参数解释:

唯一告警标识符。

取值范围:

不涉及。

status

String

参数解释:

告警状态。

取值范围:

不涉及。

alarm_source

String

参数解释:

告警来源。

取值范围:

不涉及。

alarm_content

String

参数解释:

告警内容。

取值范围:

不涉及。

alarm_data_type

String

参数解释:

告警数据类型。

取值范围:

不涉及。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及

error_msg

String

参数解释:

错误信息。

取值范围:

不涉及

请求示例

分页查询应用ID为1,页码为1,每页显示告警数量为10,告警状态为“ALERT”告警中的告警列表。

POST /v1/apm2/openapi/alarm/data/get-alarm-data-list

{
  "business_id" : 1,
  "page" : 1,
  "page_size" : 10,
  "status" : "ALERT"
}

响应示例

状态码: 200

请求响应成功,成功查询告警列表。

{
  "alarm_data_list" : [ {
    "id" : 42,
    "gmt_create" : null,
    "version_number" : null,
    "alarm_rule_type" : "TEMPLATE",
    "gmt_modify" : null,
    "process_unit" : "****-***-2-process-unit",
    "region" : "****-***-2",
    "instance_id" : 8,
    "ip_address" : "192.168.0.87",
    "instance_name" : "ins11_3",
    "env_id" : 7,
    "business_id" : 1,
    "template_id" : 2,
    "alarm_rule_id" : 3,
    "monitor_item_id" : 46,
    "collector_id" : 28,
    "collector_name" : "JVM监控",
    "alarm_rule_name" : "alarm",
    "alarm_rule_expression" : "(cpuRatio>0)",
    "alarm_first_time" : "2022-10-23 18:12:53",
    "alarm_last_time" : "2022-10-25 16:05:55",
    "alarm_level" : "COMMON",
    "restrain_key" : "7:8:3:TEMPLATE",
    "status" : "ALERT",
    "alarm_content" : "CPU0.025使用率为0.025",
    "alarm_data_type" : "SINGLE",
    "region_alarm_event_id" : 122,
    "business_name" : "default",
    "app_name" : "app_new3"
  }, {
    "id" : 41,
    "gmt_create" : null,
    "version_number" : null,
    "alarm_rule_type" : "TEMPLATE",
    "gmt_modify" : null,
    "process_unit" : "****-***-2-process-unit",
    "region" : "****-***-2",
    "instance_id" : 4,
    "ip_address" : "192.168.0.87",
    "instance_name" : "ins10_5",
    "env_id" : 5,
    "business_id" : 1,
    "template_id" : 2,
    "alarm_rule_id" : 3,
    "monitor_item_id" : 28,
    "collector_id" : 28,
    "collector_name" : "JVM监控",
    "alarm_rule_name" : "alarm",
    "alarm_rule_expression" : "(cpuRatio>0)",
    "alarm_first_time" : "2022-10-23 18:02:44",
    "alarm_last_time" : "2022-10-25 16:05:46",
    "alarm_level" : "COMMON",
    "restrain_key" : "5:4:3:TEMPLATE",
    "status" : "ALERT",
    "alarm_content" : "CPU0.025使用率为0.025",
    "alarm_data_type" : "SINGLE",
    "region_alarm_event_id" : 121,
    "business_name" : "default",
    "app_name" : "app_new5"
  } ],
  "total_count" : 2
}

状态码:400

请求参数有误。

 {
  "error_code": "apm2.00000005",
  "error_msg": "invalid parameter"
}

状态码:401

鉴权失败, 请确认token后再次请求 。

 {
  "error_msg": "Incorrect IAM authentication information: x-auth-token not found",
  "error_code": "APIGW.0301"
}

状态码:403

请求被拒绝访问。返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。

 {
  "error_code": "apm2.00000004",
  "error_msg": "has no privilege"
}

状态码:500

表明服务端能被请求访问到,但是服务内部出错。

 {
  "error_code": "apm2.00000001",
  "error_msg": "internal error"
}

状态码

状态码

描述

200

请求响应成功。

400

语义或参数有误。

401

没有权限。

403

禁止访问。

500

没有找到要请求的资源。

错误码

请参见错误码

相关文档