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

调用MiniProUpdateAlarm修改报警任务。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
commonObject of Common-通用参数。
alarm_param_listArray of Alarm_param_list-报警任务参数列表。

Common

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

Alarm_param_list

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

is_close

Integer

0

是否关闭报警。

  • 0:开启
  • 1:关闭
categoryStringpageview报警类型。调用由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报警优化,是否过滤尖刺报警。
pct_avoid_spikeObject of Pct_avoid_spike-PCT报警参数,当开启pct报警屏蔽时必填。

Strategy_list

参数类型是否必选示例值描述
measureObject of Measure-当前策略的指标列表,包括普通指标和复合指标。
filter_listArray of Filter_list-报警策略筛选条件。

alarm_strategy_type

String

threshold

报警策略类型。

  • threshold:阈值报警
  • cmp_last_n_day:比值报警
daily_compare_countInteger5同比支持过去x天。例如,取值为1表示昨天,取值为7表示上周同一天。
alarm_thresholdDouble10报警阈值。

threshold_cmp_op

String

gt

策略符号。

  • 可选值为比值报警时,取值为gt、lt。
  • 可选值为阈值报警时,取值为lt、lte、gt、gte。
alarm_user_thresholdDouble1用户数阈值。
alarm_sample_thresholdDouble1样本数量阈值。
alarm_window_sizeLong180报警任务查询时间窗口,表示最近X分钟。单位为分钟。
group_bysArray of Group_bys-报警的分组维度。
attribution_dimensionsArray 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_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接口查看取值。
valuesArray of String["Chrome"]筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

Group_bys

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

Attribution_dimensions

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

Raw_measure_list

参数类型是否必选示例值描述
measure_nameStringpv_uv.count简单指标key。调用GetAlarmMetaGetAlarmEventMetaMetric接口查看取值。
filter_listArray of Filter_list-筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。

Group_by_number_terms

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

返回参数

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

请求示例

POST https://open.volcengineapi.com?Action=MiniProUpdateAlarm&Version=2024-03-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": "minipro"
    }
}

返回示例

{
    "err_detail":"",
    "data":null,
    "error_msg":"",
    "error_no":0
}

错误码

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