应用性能监控全链路版
应用性能监控全链路版
文档指南
请输入
- 文档首页
应用性能监控全链路版API 参考API 接口 - WebPro 端报警GetAlarmHistory
复制全文
下载 pdfGetAlarmHistory
文档反馈
问问助手获取指定任务的报警历史。
请求说明
- 请求方式：POST
- 请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmHistory&Version=2022-10-12
请求参数
Common
TimeFilter
请求示例
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmHistory&Version=2022-10-12
{
"common":{
"aid":12345,
"os":"webpro"
},
"id":302,
"time_filter":{
"start_time":1665849600,
"end_time":1666011403,
"granularity":3600
},
"page_size":10,
"page_num":1
}
返回参数
Data
AlarmHistories
AlarmParam
AlarmResult
参数 | 类型 | 示例值 | 描述 |
is_alarm | Boolean | true | 是否报警。 |
strategy_result_list | - | 报警分策略报警结果。 |
StrategyList
参数 | 类型 | 示例值 | 描述 |
id | String | 123-456 | 报警ID。 |
measure | - | 当前策略的指标，包括普通指标和复合指标。 | |
filter_list | [] | 报警策略筛选条件。 | |
alarm_strategy_type | String | threshold | 报警策略类型。
|
daily_compare_count | Integer | 5 | 上一周期与当前周期的时间间隔。 当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。 |
alarm_threshold | Double | 5 | 报警阈值。 |
threshold_cmp_op | String | gt | 报警阈值的策略符号。
|
alarm_user_threshold | Double | 0 | 用户数阈值。 |
alarm_sample_threshold | Double | 0 | 样本量阈值。 |
alarm_window_size | Long | 180 | 报警任务查询时间窗口，表示最近X分钟。单位为分钟。 |
sample_metric | - | 示例指标。 | |
user_metric | - | 用户指标。 |
AlarmPeriod
NotifyConfig
StrategyResultList
参数 | 类型 | 示例值 | 描述 |
is_alarm | Boolean | true | 是否满足策略条件。 |
title | String | 慢页面次数阈值报警 | 查询结果的标题。 |
is_attributable | Boolean | false | 是否归因。 |
group_result_list | - | 报警分组结果。 |
Measure
参数 | 类型 | 示例值 | 描述 |
type | String | monomial | 指标类型。
|
raw_measure_list | - | 报警指标列表。 | |
formula | String | - | 指标四则运算公式。 当指标类型为复合指标polynomial时选填。 |
name | String | 慢页面次数 | 指标名。 当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。 |
FilterList
SampleMetric
参数 | 类型 | 示例值 | 描述 |
type | String | monomial | 指标类型。
|
raw_measure_list | - | 报警指标列表。 | |
formula | String | - | 指标四则运算公式。 当指标类型为复合指标polynomial时选填。 |
name | String | count | 指标名。 当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。 |
UserMetric
参数 | 类型 | 示例值 | 描述 |
type | String | monomial | 指标类型。
|
raw_measure_list | - | 报警指标列表。 | |
formula | String | - | 指标四则运算公式。 当指标类型为复合指标polynomial时选填。 |
name | String | user | 指标名。 当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。 |
GroupResultList
参数 | 类型 | 示例值 | 描述 |
is_alarm | Boolean | true | 是否报警。 |
group_value | String | - | 分组报警取值。比如国家分组的中国，如果不是分组报警则不返回。 |
alarm_tag_list | - | 报警列表标签。 | |
alarm_value | - | 报警值。 | |
is_spike | Boolean | false | 是否因尖刺被抑制。 |
RawMeasureList
参数 | 类型 | 示例值 | 描述 |
measure_name | String | slow_load_count | 简单指标key。 |
filter_list | [] | 筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。 | |
event_name | String | - | 自定义事件key。当指标为自定义事件指标时必填。 |
AlarmTagList
AlarmValue
参数 | 类型 | 示例值 | 描述 |
current_value | - | 当前值。 | |
alarm_threshold | - | 报警阈值。 | |
sample_count | - | 样本量。 | |
user_count | - | 用户量。 | |
window_size | - | 时间窗口。 |
CurrentValue
AlarmThreshold
SampleCount
UserCount
WindowSize
返回示例
{
"err_detail":"",
"data":{
"alarm_histories":[
{
"id":160570,
"alarm_param":{
"id":302,
"name":"jiyi-test",
"desc":"",
"is_close":0,
"category":"performance",
"category_label":"",
"alarm_level":"warning",
"strategy_list":[
{
"id":"123-456",
"measure":{
"type":"monomial",
"raw_measure_list":[
{
"measure_name":"slow_load_count",
"filter_list":[
],
"event_name":""
}
],
"formula":"",
"name":"slow page count"
},
"filter_list":[
],
"alarm_strategy_type":"threshold",
"daily_compare_count":5,
"alarm_threshold":0,
"threshold_cmp_op":"gte",
"alarm_user_threshold":0,
"alarm_sample_threshold":0,
"alarm_window_size":180,
"sample_metric":{
"type":"monomial",
"raw_measure_list":[
{
"measure_name":"browser_perf.count",
"filter_list":[
]
}
],
"formula":"",
"name":"count"
},
"user_metric":{
"type":"monomial",
"raw_measure_list":[
{
"measure_name":"browser_perf.user",
"filter_list":[
]
}
],
"formula":"",
"name":"user"
}
}
],
"strategy_op":"and",
"interval_seconds":300,
"alarm_period":{
"start_time":0,
"end_time":86399
},
"notify_config":{
"notify_types":[
"mail"
],
"notify_groups":[
287
]
},
"is_avoid_spike":false,
"aid":123456,
"os":"webpro"
},
"alarm_time":1666011480,
"alarm_content":"\nSlow page count threshold in the last 180 minutes >= 0 \n Current value: 1174, Threshold: 0, Sample size: 10745, Number of users: 458, Time window: 180 minutes\n",
"alarm_result":{
"is_alarm":true,
"strategy_result_list":[
{
"is_alarm":true,
"title":"Alarm for slow page count threshold",
"is_attributable":false,
"group_result_list":[
{
"is_alarm":true,
"group_value":"",
"alarm_tag_list":[
{
"label":"Current value",
"value":1174,
"format_value":"1174"
},
{
"label":"Threshold",
"value":0,
"format_value":"0"
},
{
"label":"Sample size",
"value":10745,
"format_value":"10745"
},
{
"label":"Number of users",
"value":458,
"format_value":"458"
},
{
"label":"Time window",
"value":180,
"format_value":"3 minutes"
}
],
"alarm_value":{
"current_value":{
"label":"Current value",
"value":1174,
"format_value":""
},
"alarm_threshold":{
"label":"Threshold",
"value":0,
"format_value":"0"
},
"sample_count":{
"label":"Sample size",
"value":10745,
"format_value":"10745"
},
"user_count":{
"label":"Number of users",
"value":458,
"format_value":"458"
},
"window_size":{
"label":"Time window",
"value":180,
"format_value":"3 minutes"
}
},
"is_spike":false
}
]
}
]
},
"operator":"bytedance-apm",
"detail_link":"/apmplus/webpro/data_search?aid=123456&end_time=1666011480&ev_type=view&start_time=1666000680"
}
],
"count":1265
},
"error_msg":"",
"error_no":0
}
错误码
最近更新时间：2026.08.28 16:25:32
这个页面对您有帮助吗？
有用
有用
无用
无用