查询告警列表
功能介绍
查询系统中存在的告警。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/apm2/openapi/alarm/data/get-alarm-data-list
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
x-business-id |
是 |
Long |
应用id。 |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page |
否 |
Integer |
页码。 |
|
page_size |
否 |
Integer |
每页数量。 |
|
region |
否 |
String |
region英文名称。 |
|
app_name |
否 |
String |
组件环境名称。 |
|
business_id |
是 |
Long |
应用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。 |
|
ip_address |
否 |
String |
实例ip地址。 |
|
env_list |
否 |
Array of integers |
环境集合。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
alarm_data_list |
Array of AlarmDataVO objects |
告警列表。 |
|
total_count |
Integer |
消息总数。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Long |
告警通知id。 |
|
gmt_create |
String |
创建时间。 |
|
gmt_create_timestamp |
Long |
创建的时间戳。 |
|
region_alarm_event_id |
Long |
region中事件的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 |
告警数据类型。 |
请求示例
分页查询应用ID为1，告警状态为告警中的告警列表。
/v1/apm2/openapi/alarm/data/get-alarm-data-list
{
"business_id" : 1,
"page" : 1,
"page_size" : 10,
"status" : "ALERT"
}
响应示例
状态码： 200
OK，请求响应成功。
{
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK，请求响应成功。 |
|
400 |
Bad Request，语义或参数有误。 |
|
401 |
Unauthorized，没有权限。 |
|
403 |
Forbidden，禁止访问。 |
|
404 |
Not Found，没有找到要请求的资源。 |
错误码
请参见错误码。
