You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/小程序Pro/报警/MiniProAlarmAttribution
MiniProAlarmAttribution
最近更新时间：2024.07.15 15:52:20首次发布时间：2024.04.03 17:37:04
我的收藏

获取报警归因信息。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
commonObject of Common是-通用参数。
alarm_paramObject of AlarmParam是-报警任务参数列表。
group_by_valueString否Chrome Webview归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。
strategy_idInteger否0报警策略下标。表示归因的策略在alarm_param.strategy_list中的下标值。
attribution_timeLong否1666012500报警归因终止时间。归因时间范围为[alarm_attribution_time-alarm_window_size*60, alarm_attribution_time]。

Common

参数类型是否必选示例值描述
aidLong是12345应用ID。
osString否minipro服务类型。取值支持app、webpro、minipro。

AlarmParam

参数类型是否必选示例值描述
idLong否1报警任务ID。
nameString是test报警任务名称。
descString是-报警说明。

is_close

Integer

否

0

是否关闭报警。

  • 0：开启
  • 1：关闭

category

String

是

-

报警类别key。调用由GetAlarmMeta接口查看取值。

  • data.measure_category_meta_list[i].key

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_spikeBoolean否false是否屏蔽尖刺报警。
pct_avoid_spikeObject of PctAvoidSpike否-PCT报警。当开启PCT报警屏蔽时必填。

StrategyList

参数类型是否必选示例值描述
measureObject of Measure否-指标集合。
filter_listArray of FilterList否-报警策略筛选条件。

alarm_strategy_type

String

否

threshold

报警策略类型。

  • threshold：阈值报警
  • cmp_last_n_day：比值报警
daily_compare_countInteger否5同比支持过去x天，为1使用昨天，7表示上周同一天
alarm_thresholdDouble否10报警阈值。

threshold_cmp_op

String

否

gt

策略符号。

  • 可选值为比值报警时，取值为gt、lt
  • 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_thresholdDouble否1用户数阈值。
alarm_sample_thresholdDouble否1样本数量阈值。
alarm_window_sizeLong否180报警任务查询时间窗口，表示最近X分钟。单位为分钟。
group_bysArray of GroupBys否-报警的分组维度。
attribution_dimensionsArray of AttributionDimensions否-报警归因维度。

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_lark_webhooks

Array of String

否

[ 291 ]

飞书通知webhooks列表。
当报警通知方式包含飞书时必填。

notify_groups

Array of Long

否

[]

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

notify_wechat_webhooks

Array of String

否

[]

企微通知webhooks列表。
当报警通知方式包含企微时必填。

notify_dingding_webhooks

Array of String

否

[]

钉钉通知webhooks列表。
当报警通知方式包含钉钉时必填。

PctAvoidSpike

参数类型是否必选示例值描述

pct

Integer

否

1

报警子窗口值。可选值为1~9。

当超过(含)X个子窗口的报警指标值超过设定的报警阈值时，才触发报警。

Measure

参数类型是否必选示例值描述

type

String

否

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList否-指标集合的列表。

formula

String

否

-

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

name

String

否

PV

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

FilterList

参数类型是否必选示例值描述

op

String

否

in

条件符号。

  • in
  • not_in
  • Regex
  • not_regex
filter_nameString否browser_brand筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。
valuesArray of String否["Chrome"]筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

GroupBys

参数类型是否必选示例值描述
labelString否pid分组指标。
group_by_number_termsArray of GroupByNumberTerms否pid分组维度key。调用GetAlarmMetricRelatedMeta接口查看取值。

AttributionDimensions

参数类型是否必选示例值描述
labelString否pid归因指标。
group_by_number_termsArray of GroupByNumberTerms否pid归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。

RawMeasureList

参数类型是否必选示例值描述
measure_nameString否pv_uv.count简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_listArray of FilterList否-筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_nameString否-自定义事件key。当指标为自定义事件指标时必填。

GroupByNumberTerms

参数类型是否必选示例值描述
nameString否-归因维度名称。
minDouble否-最小值。
maxDouble否-最大值。

返回参数

参数类型示例值描述
dataArray of Data-返回数据。每个归因维度会有一个AlarmAttribution。
error_msgString-错误信息。
error_noInteger0错误码。0为成功。

Data

参数类型示例值描述
alarm_categoryStringperformance报警任务类型。
attribution_dimensionStringpid当前归因的维度。
attribution_dimension_labelStringTOP pid当前归因的维度名称。
detail_listArray of DetailList-按归因维度group后的top3。

DetailList

参数类型示例值描述
nameStringJS监控列表归因后topN的字段的值。
linkString-报警时间，为source[i][0]值的含义。

请求示例

POST https://open.volcengineapi.com?Action=MiniProAlarmAttribution&Version=2024-03-12
{
    "common": {
        "aid": 12345,
        "os": "minipro"
    },
    "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
        }
    },
    "strategy_id": 0,
    "attribution_time": 1666012500,
    "group_by_value": "Chrome Webview"
}

返回示例

{
    "err_detail":"",
    "data":[
        {
            "alarm_category":"performance",
            "attribution_dimension":"pid",
            "attribution_dimension_label":"TOP pid",
            "detail_list":[
                {
                    "name":"JS 监控列表",
                    "link":""
                }
            ]
        },
        {
            "alarm_category":"performance",
            "attribution_dimension":"pid",
            "attribution_dimension_label":"TOP 同上周期比增长最快  pid",
            "detail_list":[
                {
                    "name":"JS 监控列表",
                    "link":""
                }
            ]
        }
    ],
    "error_msg":"",
    "error_no":0
}

错误码

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