You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
报警
PCAlarmHistory
复制全文
下载 pdf
PCAlarmHistory
查看报警历史。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=PCAlarmHistory&Version=2022-10-28​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
PCAlarmHistory​
接口名称。当前 API 的名称为 PCAlarmHistory。​
Version​
String​
是​
2022-10-28​
接口版本。当前 API 的版本为 2022-10-28。​
common​
Object of CommonParams​
是​
-​
通用参数。​
id​
Long​
是​
1​
报警规则ID。​
page_size​
Integer​
是​
3​
每页显示历史记录数。​
page_num​
Integer​
是​
1​
返回页码号​
time_filter​
Object of TimeFilter​
是​
-​
时间过滤。​
​
CommonParams​
​
参数​
类型​
是否必选​
示例值​
描述​
os​
String​
是​
pc​
系统。​
aid​
Long​
是​
12345​
App ID。​
env​
String​
否​
crash​
环境信息。​
​
TimeFilter​
​
参数​
类型​
是否必选​
示例值​
描述​
end_time​
Integer​
是​
1655971939​
结束时间。​
start_time​
Integer​
是​
1655308800​
开始时间。​
granularity​
Integer​
否​
3​
聚合颗粒度,单位为秒。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=PCAlarmHistory&Version=2022-10-28​
{​
"common": {​
"aid": 12345,​
"os": "pc",​
"env": "crash",​
"site_type": ""​
},​
"id": 1,​
"page_size": 3,​
"page_num": 1,​
"time_filter": {​
"start_time": 1655308800,​
"end_time": 1655971939,​
"granularity": 3​
}​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
Object of AlarmHistoryList​
-​
返回内容。​
errmsg​
String​
""​
错误信息,成功为空。​
errno​
Integer​
200​
错误码,成功为200。​
​
AlarmHistoryList​
​
参数​
类型​
示例值​
描述​
count​
Integer​
30​
报警总数。​
alarm_histories​
Array of AlarmHistory​
-​
报警历史列表。​
​
AlarmHistory​
​
参数​
类型​
示例值​
描述​
id​
Long​
1​
报警ID。​
operator​
String​
zhangsan​
最近更新人。​
alarm_time​
Long​
1655391060​
报警发生时间。​
alarm_param​
Object of AlarmParam​
-​
报警参数。​
alarm_result​
Object of AlarmResult​
-​
报警计算结果。​
alarm_content​
String​
最近180分钟test_service_gyf/xxxxxx​
报警内容。​
​
AlarmParam​
​
参数​
类型​
示例值​
描述​
id​
Long​
1​
创建时不传,更新时传。​
desc​
String​
新的报警​
报警说明。​
name​
String​
minitor​
报警名称。​
category​
String​
pc_flexible​
报警类型。​
is_close​
Integer​
1​
是否关闭报警。​
  • 0:开启​
  • 1:关闭​
alarm_level​
String​
Warn​
报警级别。​
  • Notice​
  • Warn​
  • Fatal​
strategy_op​
String​
and​
多策略关系。​
  • and​
  • or​
alarm_period​
Object of AlarmPeriod​
-​
报警时间段。​
notify_config​
Object of NotifyConfig​
-​
报警通知。​
strategy_list​
Array of AlarmStrategy​
-​
报警策略。​
category_label​
String​
""​
报警类型展示名称。​
interval_seconds​
Integer​
300​
报警间隔,最短5分钟。​
​
AlarmResult​
​
参数​
类型​
示例值​
描述​
is_alarm​
Boolean​
true​
是否报警。​
strategy_result_list​
Array of StrategyResult​
-​
分策略报警结果。​
​
AlarmPeriod​
​
参数​
类型​
示例值​
描述​
end_time​
Integer​
86399​
报警结束时间,单位秒。​
start_time​
Integer​
0​
报警开始时间,单位秒。​
​
NotifyConfig​
​
参数​
类型​
示例值​
描述​
notify_types​
Array of String​
["mail"]​
报警通知方式。​
  • lark​
  • mail​
  • wechat​
  • dingding​
notify_groups​
Array of Long​
[1,23]​
邮件接收组ID列表。​
upgrade_groups​
Array of Long​
[1,23]​
升级邮件接收组ID列表。​
notify_lark_webhooks​
Array of String​
["http://lark/url"]​
飞书通知webhook列表。​
notify_wechat_webhooks​
Array of String​
["http://wechat/url"]​
企业微信通知webhook列表。​
notify_dingding_webhooks​
Array of String​
["http://dingding/url"]​
钉钉通知webhook列表。​
​
AlarmStrategy​
​
参数​
类型​
示例值​
描述​
id​
String​
9018754602-1655285699772​
当新建报警策略的时候前端生成,用于后端画趋势图。​
measure​
Object of FlexMeasure​
-​
指标集合。​
group_bys​
Array of FlexGroupBy​
-​
报警的分组。​
filter_list​
Array of FlexFilter​
-​
过滤条件。​
alarm_threshold​
Double​
10​
报警阈值。​
threshold_cmp_op​
String​
gt​
报警阈值的op。​
  • gt​
  • gte​
  • lt​
  • lte​
  • abs_gt​
  • abs_gte​
alarm_window_size​
Long​
180​
时间窗口,单位s。​
alarm_strategy_type​
String​
threshold​
指标计算策略。​
  • 阈值:threshold​
  • 同比:cmp_last_n_day​
daily_compare_count​
Integer​
60​
同比支持过去x分钟。​
alarm_sample_threshold​
Double​
3​
样本数量阈值。​
​
StrategyResult​
​
参数​
类型​
示例值​
描述​
title​
String​
崩溃数​
指标名称。​
is_alarm​
Boolean​
true​
是否报警。​
groupField​
String​
os​
分组报警时的分组字段、​
group_result_list​
Array of GroupResult​
-​
分组报警结果。​
​
FlexMeasure​
​
参数​
类型​
示例值​
描述​
name​
String​
崩溃影响用户数​
指标名称。​
type​
String​
monomial​
指标类型。​
  • monomial​
  • polynomial​
customId​
String​
xe3ejx98​
前端用于还原页面。​
raw_measure_list​
Array of FlexRawMeasure​
-​
具体查询指标。​
​
FlexGroupBy​
​
参数​
类型​
示例值​
描述​
label​
String​
OS​
分组展示名称。​
group_by_name​
String​
os​
分组维度。​
​
FlexFilter​
​
参数​
类型​
示例值​
描述​
op​
String​
in​
过滤方式。​
values​
Array of String​
["intel", "Qualcomm"]​
过滤值。​
filter_name​
String​
cpu​
用于表明filter的哪个维度。​
​
GroupResult​
​
参数​
类型​
示例值​
描述​
is_alarm​
Boolean​
true​
是否报警。​
group_value​
String​
""​
分组值,比如国家分组的中国,如果不是分组报警则不返回。​
alarm_tag_list​
Array of Tag​
-​
计算相关统计值。​
​
FlexRawMeasure​
​
参数​
类型​
示例值​
描述​
event_name​
String​
test_service_gyf​
前端传了此参数, 后端没有用到。但是还原图表的时候是从这个字段读的事件名。​
filter_list​
Array of FlexFilter​
-​
过滤条件。​
measure_name​
String​
"{"metric":"pc_flexible.count","event_dimension":"pc_flexible.event_name","event_name":"test_service_gyf"}"​
具体的指标计算值。​
​
Tag​
​
参数​
类型​
示例值​
描述​
label​
String​
样本量​
展示标签。​
value​
Double​
30​
具体值。​
format_value​
String​
30​
格式化后的值,暂时只有时间窗口有特殊处理 加时间单位。​
​
返回示例​
​
{​
"data": {​
"count": 30,​
"alarm_histories": [​
{​
"alarm_content": "In the last 180 minutes, test_service_gyf/xxxxxx",​
"alarm_param": {​
"name": "minitor",​
"desc": "New alarm",​
"is_close": 1,​
"category": "pc_flexible",​
"alarm_level": "Warn",​
"strategy_list": [​
{​
"id": "9018754602-1655285699772",​
"alarm_strategy_type": "threshold",​
"alarm_threshold": 10,​
"threshold_cmp_op": "gt",​
"alarm_window_size": 180,​
"alarm_sample_threshold": 3,​
"group_bys": [​
{​
"group_by_name": "os",​
"label": "OS"​
}​
],​
"daily_compare_count": 60,​
"filter_list": [​
{​
"op": "in",​
"filter_name": "cpu",​
"values": [​
"intel",​
"Qualcomm"​
]​
}​
]​
}​
],​
"strategy_op": "and",​
"interval_seconds": 300,​
"alarm_period": {​
"start_time": 156,​
"end_time": 86399​
},​
"id": 1,​
"category_label": "sitting",​
"notify_config": {​
"notify_lark_webhooks": [​
"http://lark/url"​
],​
"notify_groups": [​
1,​
23​
],​
"notify_wechat_webhooks": [​
"http://wechat/url"​
],​
"notify_dingding_webhooks": [​
"http://dingding/url"​
],​
"notify_types": [​
"mail"​
],​
"upgrade_groups": [​
1,​
23​
]​
}​
},​
"id": 1,​
"alarm_result": {​
"strategy_result_list": [​
{​
"groupField": "os",​
"is_alarm": true,​
"title": "Number of crashes",​
"group_result_list": [​
{​
"group_value": "",​
"alarm_tag_list": [​
{​
"value": 30,​
"format_value": "30",​
"label": "Sample size"​
}​
],​
"is_alarm": true​
}​
]​
}​
],​
"is_alarm": true​
},​
"alarm_time": 1655391060,​
"operator": "zhangsan"​
}​
]​
},​
"errno": 200,​
"errmsg": ""​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:24:40
这个页面对您有帮助吗?
有用
有用
无用
无用