文档中心

MiniProAlarmList

最近更新时间：2024.04.17 17:39:51

首次发布时间：2024.04.03 17:37:06

调用MiniProAlarmList获取报警任务列表。

请求说明

请求方式：POST
请求地址：?Action=MiniProAlarmList&Version=2024-03-12

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`MiniProAlarmList`	接口名称。当前 API 的名称为 `MiniProAlarmList`。
Version	String	是	`2024-03-12`	接口版本。当前 API 的版本为 `2024-03-12`。

Body

参数	类型	是否必选	示例值	描述
common	Object of Common	是	`-`	通用参数。
self	Integer	否	`1`	是否返回我管理的任务列表。 1：返回我管理的任务列表。 0：返回全部。
category_list	Array of String	否	`["pageview"]`	报警类型筛选。不填时返回全部报警类型的报警任务，非空时返回指定报警类型的报警任务，调用`GetAlarmMeta`接口查看取值。
keyword	String	否	`test`	报警任务名称模糊搜索。不填时返回全部报警任务，填时返回任务名满足条件的报警任务。
page_num	Long	否	`1`	报警任务列表页数。
page_size	Long	否	`10`	报警任务列表返回的项数。

Common

参数	类型	是否必选	示例值	描述
aid	Long	是	`12345`	应用ID。
os	String	否	`minipro`	服务类型。取值支持app、webpro、minipro。

返回参数

参数	类型	示例值	描述
data	Object of Data	`-`	返回数据。
error_msg	String	`-`	错误信息。
error_no	Integer	`0`	错误码。0为成功。

Data

参数	类型	示例值	描述
alarm_rule_list	Array of Alarm_rule_list	`-`	报警任务列表。
count	Integer	`1`	报警任务数。

Alarm_rule_list

参数	类型	示例值	描述
alarm_param	Object of Alarm_param	`-`	报警参数集合。
created_by	String	`leeac`	报警任务创建人。
updated_by	String	`leeac`	报警任务最近修改人。
created_time	Long	`1665409567`	报警任务创建时间。
updated_time	Long	`1665409567`	报警任务最近修改时间。
next_trigger_time	Long	`1665409567`	报警任务下次触发时间。
last_execute_time	Long	`0`	报警任务上次执行时间。
ack_until_time	Long	`0`	报警任务ACK到期时间。
num_of_alarm_in_last_one_month	Integer	`0`	报警任务最近一个月报警次数。

Alarm_param

参数	类型	示例值	描述
id	Long	`1`	报警任务ID。
name	String	`test`	报警任务名称。
desc	String	`-`	报警说明。
category	String	`pageview`	报警类别key。调用由`GetAlarmMeta`接口查看取值。 data.measure_category_meta_list[i].key
alarm_level	String	`warning`	报警级别。 warning fatal
strategy_list	Array of Strategy_list	`-`	报警策略列表。
strategy_op	String	`and`	报警多策略关系。 and：同时满足所有策略 or：满足任一策略
interval_seconds	Integer	`300`	报警任务执行间隔。 300：5分钟 600：10分钟 1800：30分钟 3600：60分钟
alarm_period	Object of Alarm_period	`-`	报警生效时间。时间范围外的报警不通知。
notify_config	Object of Notify_config	`-`	报警任务通知配置。
is_avoid_spike	Boolean	`false`	是否屏蔽尖刺报警。
pct_avoid_spike	Object of Pct_avoid_spike	`-`	PCT报警参数。当开启PCT报警屏蔽时必填。

Strategy_list

参数	类型	示例值	描述
measure	Object of Measure	`-`	当前策略的指标集合，包括普通指标和复合指标。
filter_list	Array of Filter_list	`-`	报警策略筛选条件。
alarm_strategy_type	String	`threshold`	报警策略类型。 threshold：阈值报警 cmp_last_n_day：比值报警
daily_compare_count	Integer	`5`	上一周期与当前周期的时间间隔。当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。
alarm_threshold	Double	`10`	报警阈值。
threshold_cmp_op	String	`gt`	策略符号。可选值为比值报警时，取值为gt、lt 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_threshold	Double	`1`	用户数阈值。
alarm_sample_threshold	Double	`1`	样本数量阈值。
alarm_window_size	Long	`180`	报警任务查询时间窗口，表示最近X分钟。单位为分钟。
group_bys	Array of Group_bys	`-`	报警的分组维度。
attribution_dimensions	Array of Attribution_dimensions	`-`	报警归因维度。

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_webhooks	Array of String	`[]`	飞书通知webhooks列表。当报警通知方式包含飞书时必填。
notify_groups	Array of Long	`[ 291 ]`	报警通知邮件组ID列表。当报警通知方法包含邮件时必填。
notify_wechat_webhooks	Array of String	`[]`	企微通知webhooks列表。当报警通知方式包含企微时必填。
notify_dingding_webhooks	Array of String	`[]`	钉钉通知webhooks列表。当报警通知方式包含钉钉时必填。

Pct_avoid_spike

参数	类型	示例值	描述
pct	Integer	`1`	报警子窗口值。可选值为1~9。当超过(含)X个子窗口的报警指标值超过设定的报警阈值时，才触发报警。

Measure

参数	类型	示例值	描述
type	String	`monomial`	指标类型。 monomial：普通指标 polynomial：复合指标
raw_measure_list	Array of Raw_measure_list	`-`	报警指标列表。
formula	String	`-`	指标四则运算公式。当指标类型为复合指标polynomial时选填。
name	String	`PV`	指标名。当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

参数	类型	示例值	描述
op	String	`in`	条件符号。 in not_in Regex not_regex
filter_name	String	`browser_brand`	筛选条件key。调用`GetAlarmMetricRelatedMeta`接口查看取值。
values	Array of String	`["Chrome"]`	筛选条件值。调用`GetAlarmMetricCandidate`接口查看取值。

参数

类型

示例值

描述

String

in

条件符号。

in
not_in
Regex
not_regex

filter_name

String

browser_brand

筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。

values

Array of String

["Chrome"]

筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

Group_bys

参数	类型	示例值	描述
label	String	`pid`	分组指标。
group_by_number_terms	Array of Group_by_number_terms	`pid`	分组维度key。调用`GetAlarmMetricRelatedMeta`接口查看取值。

Attribution_dimensions

参数	类型	示例值	描述
label	String	`pid`	归因指标。
group_by_number_terms	Array of Group_by_number_terms	`pid`	归因维度key。调用`GetAlarmMetricRelatedMeta`接口查看取值。

Raw_measure_list

参数	类型	示例值	描述
measure_name	String	`pv_uv.count`	简单指标key。调用`GetAlarmMeta`和`GetAlarmEventMetaMetric`接口查看取值。
filter_list	Array of Filter_list	`-`	筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_name	String	`-`	自定义事件key。当指标为自定义事件指标时必填。

Group_by_number_terms

参数	类型	示例值	描述
name	String	`-`	归因维度名称。
min	Double	`-`	最小值。
max	Double	`-`	最大值。

示例

请求示例

POST ?Action=MiniProAlarmList&Version=2024-03-12
{
    "common": {
        "aid": 12345,
        "os": "minipro"
    },
    "category_list": [
        "pageview"
    ],
    "keyword": "test",
    "self": 1,
    "page_num": 1,
    "page_size": 10
}

返回示例

{
    "err_detail":"",
    "data":{
        "alarm_param":{
            "id":1,
            "name":"test",
            "alarm_level":"warning",
            "desc":"",
            "category":"pageview",
            "interval_seconds":300,
            "strategy_op":"and",
            "strategy_list":[
                {
                    "alarm_window_size":180,
                    "measure":{
                        "type":"monomial",
                        "raw_measure_list":[
                            {
                                "measure_name":"pv_uv.count",
                                "event_name":"",
                                "filter_list":[
                                    {
                                        "filter_name":"browser_brand",
                                        "values":[
                                            "Chrome"
                                        ],
                                        "op":"in"
                                    }
                                ]
                            }
                        ],
                        "formula":"",
                        "name":"PV",
                        "unit":{
                            "unit_type":"",
                            "unit":""
                        }
                    },
                    "alarm_strategy_type":"threshold",
                    "daily_compare_count":5,
                    "threshold_cmp_op":"gt",
                    "alarm_threshold":10,
                    "group_bys":[
                        {
                            "label":"pid",
                            "group_by_name":"pid"
                        }
                    ],
                    "attribution_dimensions":[
                        {
                            "label":"pid",
                            "group_by_name":"pid"
                        }
                    ],
                    "filter_list":[
                        {
                            "filter_name":"pid",
                            "op":"in",
                            "values":[
                                "看板"
                            ]
                        }
                    ],
                    "alarm_user_threshold":1,
                    "alarm_sample_threshold":1
                }
            ],
            "alarm_period":{
                "start_time":0,
                "end_time":86399
            },
            "notify_config":{
                "notify_types":[
                    "mail"
                ],
                "notify_groups":[
                    291
                ],
                "notify_lark_webhooks":[

                ],
                "notify_wechat_webhooks":[

                ],
                "notify_dingding_webhooks":[

                ]
            },
            "is_avoid_spike":false,
            "is_close":0,
            "pct_avoid_spike":{
                "pct":1
            }
        },
        "created_by":"leeac",
        "updated_by":"leeac",
        "created_time":1666008398,
        "updated_time":1666008398,
        "next_trigger_time":1666008698,
        "last_execute_time":0,
        "ack_until_time":0
    },
    "error_msg":"",
    "error_no":0
}

应用性能监控全链路版