You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/报警/GetAlarmHistory
GetAlarmHistory
最近更新时间：2024.07.12 17:21:38首次发布时间：2022.11.01 11:26:01
我的收藏

获取指定任务的报警历史。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com/?Action=GetAlarmHistory&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing 
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetAlarmHistory接口名称。当前 API 的名称为 GetAlarmHistory。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
commonObject of Common否-通用参数。
idLong否302报警任务ID列表。
page_sizeInteger否30分页查询参数，用于设置每页行数。默认值：30。
page_numInteger否1分页查询参数，用于设置当前页码。默认值：1。
time_filterObject of TimeFilter否-时间区间。

Common

参数类型是否必选示例值描述
aidLong否12345应用ID。
osString否webpro服务类型。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger否1665849600起始时间。
granularityInteger否60聚合时间粒度。
end_timeInteger否1666011403终止时间。

返回参数

参数类型示例值描述
dataObject of Data-返回内容。
error_msgString""错误信息。成功为""。
error_noInteger0错误码。成功为0。

Data

参数类型示例值描述
alarm_historiesArray of AlarmHistories-报警趋势。
countInteger1报警数。

AlarmHistories

参数类型示例值描述
idLong160570报警历史ID。
alarm_paramObject of AlarmParam-报警参数。
alarm_timeLong1666011480报警发生时间。
alarm_contentString-报警内容。
alarm_resultObject of AlarmResult-报警结果。
operatorStringbytedance-apm报警任务创建人。
detail_linkString/apmplus/webpro/data_search?aid=12345&end_time=1666011480&ev_type=view&start_time=1666000680报警详情链接。

AlarmParam

参数类型示例值描述
idLong302报警任务ID。
nameStringjiyi-test报警任务名称。
descString-报警说明。

is_close

Integer

0

是否关闭报警。

  • 0：开启
  • 1：关闭
categoryStringperformance报警类型。

category_label

String

-

报警类型筛选。

不填时返回全部报警类型的报警任务，非空时返回指定报警类型的报警任务，调用GetAlarmMeta接口查看取值。

alarm_level

String

warning

报警级别。

  • warning
  • fatal
strategy_listArray of StrategyList-报警策略列表。

strategy_op

String

and

报警多策略关系。

  • and：同时满足所有策略
  • or：满足任一策略

interval_seconds

Integer

300

报警任务执行间隔。

  • 300：5分钟
  • 600：10分钟
  • 1800：30分钟
  • 3600：60分钟
alarm_periodObject of AlarmPeriod-报警生效时间。时间范围外的报警不通知。
notify_configObject of NotifyConfig-通知配置。
is_avoid_spikeBooleanfalse是否屏蔽尖刺报警。

AlarmResult

参数类型示例值描述
is_alarmBooleantrue是否报警。
strategy_result_listArray of StrategyResultList-报警分策略报警结果。

StrategyList

参数类型示例值描述
idString123-456报警ID。
measureObject of Measure-当前策略的指标，包括普通指标和复合指标。
filter_listArray of FilterList[]报警策略筛选条件。

alarm_strategy_type

String

threshold

报警策略类型。

  • threshold：阈值报警
  • cmp_last_n_day：比值报警

daily_compare_count

Integer

5

上一周期与当前周期的时间间隔。
当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。

alarm_thresholdDouble5报警阈值。

threshold_cmp_op

String

gt

报警阈值的策略符号。

  • 可选值为比值报警时，取值为gt、lt
  • 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_thresholdDouble0用户数阈值。
alarm_sample_thresholdDouble0样本量阈值。
alarm_window_sizeLong180报警任务查询时间窗口，表示最近X分钟。单位为分钟。
sample_metricObject of SampleMetric-示例指标。
user_metricObject of UserMetric-用户指标。

AlarmPeriod

参数类型示例值描述

start_time

Integer

0

报警生效开始时间。
值为开始时间相对当天0点的秒时间戳，比如生效开始时间为当天2点，值为7200。

end_time

Integer

86399

报警生效结束时间。
值为结束时间相对当天0点的秒时间戳，比如生效结束时间为当天23:59:59，值为86399。

NotifyConfig

参数类型示例值描述

notify_types

Array of String

[ "mail" ]

报警任务通知方式。

  • mail：邮箱
  • lark：飞书
  • wechat：企业微信
  • dingding：钉钉

notify_groups

Array of Long

287

报警通知邮件组ID列表。
当报警通知方法包含邮件时必填。

StrategyResultList

参数类型示例值描述
is_alarmBooleantrue是否满足策略条件。
titleString慢页面次数阈值报警查询结果的标题。
is_attributableBooleanfalse是否归因。
group_result_listArray of GroupResultList-报警分组结果。

Measure

参数类型示例值描述

type

String

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList-报警指标列表。

formula

String

-

指标四则运算公式。
当指标类型为复合指标polynomial时选填。

name

String

慢页面次数

指标名。
当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

FilterList

参数类型示例值描述
opString-筛选条件和筛选值之间的关系。
filter_nameString-筛选指标名称。
valuesArray of String-筛选指标的取值。

SampleMetric

参数类型示例值描述

type

String

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList-报警指标列表。

formula

String

-

指标四则运算公式。
当指标类型为复合指标polynomial时选填。

name

String

count

指标名。
当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

UserMetric

参数类型示例值描述

type

String

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList-报警指标列表。

formula

String

-

指标四则运算公式。
当指标类型为复合指标polynomial时选填。

name

String

user

指标名。
当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

GroupResultList

参数类型示例值描述
is_alarmBooleantrue是否报警。
group_valueString-分组报警取值。比如国家分组的中国，如果不是分组报警则不返回。
alarm_tag_listArray of AlarmTagList-报警列表标签。
alarm_valueObject of AlarmValue-报警值。
is_spikeBooleanfalse是否因尖刺被抑制。

RawMeasureList

参数类型示例值描述
measure_nameStringslow_load_count简单指标key。
filter_listArray of FilterList[]筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_nameString-自定义事件key。当指标为自定义事件指标时必填。

AlarmTagList

参数类型示例值描述
labelString当前值指标。
valueDouble1172当前指标的取值。
format_valueString1172格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

AlarmValue

参数类型示例值描述
current_valueObject of CurrentValue-当前值。
alarm_thresholdObject of AlarmThreshold-报警阈值。
sample_countObject of SampleCount-样本量。
user_countObject of UserCount-用户量。
window_sizeObject of WindowSize-时间窗口。

CurrentValue

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString-格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

AlarmThreshold

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString-格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

SampleCount

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString-格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

UserCount

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString-格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

WindowSize

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString-格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

请求示例

POST https://open.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
}

返回示例

{
    "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":"慢页面次数"
                            },
                            "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":"\n最近180分钟慢页面次数阈值>=0    \n    当前值:1174 阈值:0 样本量:10745 用户数:458 时间窗口:180分钟\n",
                "alarm_result":{
                    "is_alarm":true,
                    "strategy_result_list":[
                        {
                            "is_alarm":true,
                            "title":"慢页面次数阈值报警",
                            "is_attributable":false,
                            "group_result_list":[
                                {
                                    "is_alarm":true,
                                    "group_value":"",
                                    "alarm_tag_list":[
                                        {
                                            "label":"当前值",
                                            "value":1174,
                                            "format_value":"1174"
                                        },
                                        {
                                            "label":"阈值",
                                            "value":0,
                                            "format_value":"0"
                                        },
                                        {
                                            "label":"样本量",
                                            "value":10745,
                                            "format_value":"10745"
                                        },
                                        {
                                            "label":"用户数",
                                            "value":458,
                                            "format_value":"458"
                                        },
                                        {
                                            "label":"时间窗口",
                                            "value":180,
                                            "format_value":"3 分钟"
                                        }
                                    ],
                                    "alarm_value":{
                                        "current_value":{
                                            "label":"当前值",
                                            "value":1174,
                                            "format_value":""
                                        },
                                        "alarm_threshold":{
                                            "label":"阈值",
                                            "value":0,
                                            "format_value":"0"
                                        },
                                        "sample_count":{
                                            "label":"样本量",
                                            "value":10745,
                                            "format_value":"10745"
                                        },
                                        "user_count":{
                                            "label":"用户数",
                                            "value":458,
                                            "format_value":"458"
                                        },
                                        "window_size":{
                                            "label":"时间窗口",
                                            "value":180,
                                            "format_value":"3 分钟"
                                        }
                                    },
                                    "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
}

错误码

本接口无特有的错误码。更多信息请参见错误码。