AddAlarm--应用性能监控全链路版-火山引擎

文档中心

导航

AddAlarm

最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:01

新建报警任务。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=AddAlarm&Version=2022-10-12

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
common	Object of Common	否	`-`	通用参数。
alarm_param_list	Array of AlarmParamList	否	`-`	报警任务参数列表。

Common

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

AlarmParamList

参数	类型	是否必选	示例值	描述
name	String	否	`test`	报警任务名称。
desc	String	否	`-`	报警说明。
is_close	Integer	否	`0`	是否关闭报警。 0：开启 1：关闭
category	String	否	`pageview`	报警类别key。调用由`GetAlarmMeta`接口查看取值。
alarm_level	String	否	`warning`	报警级别。支持warning，fatal。
strategy_list	Array of StrategyList	否	`-`	报警策略列表。
strategy_op	String	否	`and`	多策略关系。 and：同时满足所有策略 or：满足任一策略
interval_seconds	Integer	否	`300`	报警任务执行间隔。 300：5分钟 600：10分钟 1800：30分钟 3600：60分钟
alarm_period	Object of AlarmPeriod	否	`-`	报警生效时间。时间范围外的报警不通知。
notify_config	Object of NotifyConfig	否	`-`	报警任务通知配置。
is_avoid_spike	Boolean	否	`false`	报警优化，是否过滤尖刺报警。
pct_avoid_spike	Object of PctAvoidSpike	否	`-`	pct报警参数，当开启pct报警屏蔽时必填。

StrategyList

参数	类型	是否必选	示例值	描述
measure	Object of Measure	否	`-`	指标的集合。
filter_list	Array of FilterList	否	`-`	报警策略筛选条件。
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 GroupBys	否	`-`	报警的分组维度。
attribution_dimensions	Array 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	否	`[]`	飞书通知webhooks列表。当报警通知方式包含飞书时必填。
notify_groups	Array of Long	否	`[291]`	报警通知邮件组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_list	Array of RawMeasureList	否	`-`	所有指标的集合。
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"]`	筛选条件值。调用`GetAlarmMeticCandidate`接口查看取值。

GroupBys

参数	类型	是否必选	示例值	描述
group_by_name	String	否	`pid`	分组维度key。调用`GetAlarmMetricRelatedMeta`接口查看取值。
label	String	否	`pid`	分组指标。

AttributionDimensions

参数	类型	是否必选	示例值	描述
group_by_name	String	否	`pid`	归因维度key。调用`GetAlarmMetricRelatedMeta`接口查看取值。
label	String	否	`pid`	归因指标。

RawMeasureList

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

返回参数

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

Data

参数	类型	示例值	描述
ids	Array of Long	`[ 303 ]`	报警任务ID。

请求示例

POST https://open.volcengineapi.com/?Action=AddAlarm&Version=2022-10-12

{
    "alarm_param_list":[
        {
            "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
            }
        }
    ],
    "common":{
        "aid":12345,
        "os":"webpro"
    }
}

返回示例

{
    "err_detail":"",
    "data":[
        303
    ],
    "error_msg":"",
    "error_no":0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Common

AlarmParamList

StrategyList

AlarmPeriod

NotifyConfig

PctAvoidSpike

Measure

FilterList

GroupBys

AttributionDimensions

RawMeasureList

返回参数

Data

请求示例

返回示例

错误码