You need to enable JavaScript to run this app.
导航
MiniProAlarmHistory
最近更新时间:2024.06.18 17:13:43首次发布时间:2024.04.03 17:37:05

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=MiniProAlarmHistory&Version=2024-03-12

请求参数

ServiceName : apmplus_openapi 
Region : cn-beijing 
X-App-Ids : xxx 
Content-Type : application/json

Query

参数类型是否必选示例值描述
ActionStringMiniProAlarmHistory接口名称。当前 API 的名称为 MiniProAlarmHistory
VersionString2024-03-12接口版本。当前 API 的版本为 2024-03-12

Body

参数类型是否必选示例值描述
commonObject of Common-通用参数。
time_filterObject of Time_filter-时间区间。
idLong302报警任务ID列表。
page_sizeInteger10报警历史列表返回项数。
page_numInteger1报警历史列表页数。

Common

参数类型是否必选示例值描述
aidLong12345应用ID。
osStringminipro服务类型。取值支持appwebprominipro

Time_filter

参数类型是否必选示例值描述
start_timeInteger1665849600起始时间。
granularityInteger60聚合时间粒度。
end_timeInteger1666011403终止时间。

返回参数

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

Data

参数类型示例值描述
alarm_historiesArray of Alarm_histories-报警历史详情。

Alarm_histories

参数类型示例值描述
idLong160570报警历史ID。
alarm_paramObject of Alarm_param-报警参数。
alarm_timeLong1666011480报警发生时间。
alarm_contentString-报警内容。
alarm_resultObject of Alarm_result-报警结果。

Alarm_param

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

is_close

Integer

0

是否关闭报警。

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

category_label

String

-

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

alarm_level

String

warning

报警级别。

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

strategy_op

String

and

报警多策略关系。

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

interval_seconds

Integer

300

报警任务执行间隔。

  • 300:5分钟
  • 600:10分钟
  • 1800:30分钟
  • 3600:60分钟
alarm_periodObject of Alarm_period-报警生效时间。
notify_configObject of Notify_config-报警任务通知配置。
is_avoid_spikeBooleanfalse是否屏蔽尖刺报警。

Alarm_result

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

Strategy_list

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

alarm_strategy_type

String

threshold

报警策略类型。

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

daily_compare_count

Integer

5

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

alarm_thresholdDouble0报警阈值。

threshold_cmp_op

String

gte

策略符号。

  • 可选值为比值报警时,取值为gt、lt
  • 可选值为阈值报警时,取值为lt、lte、gt、gte
alarm_user_thresholdDouble0用户数阈值。
alarm_sample_thresholdDouble0样本数量阈值。
alarm_window_sizeLong180报警任务查询时间窗口,表示最近X分钟。单位为分钟。

Alarm_period

参数类型示例值描述

start_time

Integer

0

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

end_time

Integer

86399

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

Notify_config

参数类型示例值描述

notify_types

Array of String

[ "mail" ]

报警任务通知方式。

  • mail:邮箱
  • lark:飞书
  • wechat:企业微信
  • dingding:钉钉
notify_lark_webhooksArray of String[]飞书通知webhook列表。
notify_groupsArray of Long287邮件接收组id列表
notify_wechat_webhooksArray of String[]企业微信通知webhook列表。
notify_dingding_webhooksArray of String[]钉钉通知webhook列表。

Strategy_result_list

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

Measure

参数类型示例值描述

type

String

monomial

指标类型。

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

formula

String

-

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

name

String

慢页面次数

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

Filter_list

参数类型示例值描述

op

String

in

条件符号。

  • in
  • not_in
  • Regex
  • not_regex
filter_nameStringbrowser_brand筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。用于表明filter的那个维度
valuesArray of String["Chrome"]筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

Group_result_list

参数类型示例值描述
is_alarmBooleantrue是否报警。
group_valueString-分组报警取值,比如国家分组的中国,如果不是分组报警则不返回。
alarm_tag_listArray of Alarm_tag_list-报警列表标签。
is_spikeBooleanfalse是否尖刺过滤。

Raw_measure_list

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

Alarm_tag_list

参数类型示例值描述
labelString当前值指标。
valueDouble1174当前指标的取值。
format_valueString1174格式化后的值。

请求示例

POST https://open.volcengineapi.com?Action=MiniProAlarmHistory&Version=2024-03-12
{
    "common": {
        "aid": 12345,
        "os": "minipro"
    },
    "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":"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":"minipro"
                },
                "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/minipro/data_search?aid=123456&end_time=1666011480&ev_type=view&start_time=1666000680"
            }
        ],
        "count":1265
    },
    "error_msg":"",
    "error_no":0
}

错误码

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