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

文档中心

导航

SetAppAlarmRule

最近更新时间：2024.07.15 16:31:27首次发布时间：2022.11.18 17:53:52

新建或更新App报警任务。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
id	Long	否	`1`	报警规则ID，如果是新建的可以不传。
name	String	是	`task_test`	规则名称。
description	String	否	`alarm for xxx`	规则描述。
monitor_type	String	是	`crash`	监控类型。 crash：崩溃 crash_defend：崩溃防护 lag：卡顿 flutter_crash：flutter监控 app_page_js_err：页面监控/js错误 app_page_ajax_err：页面监控/请求错误 app_page_perf：页面监控/性能 app_event：事件报警 net_err：网络错误 custom_exception：自定义错误 traffic_exception：流量 disk_exception：磁盘 battery_trace：电量 cpu_exception：CPU
alarm_level	String	是	`warning`	报警级别。 warning fatal
check_cycle	Long	是	`5`	监测周期，分钟为单位，瞬时报警请填0。
activations	Array of Activation	否	`-`	多个时间段。
filter	Object of FilterCondition	否	`-`	报警指标筛选条件。
group_bys	Array of GroupBy	否	`-`	报警分组条件。
hit_rule	Object of AlarmHitRule	是	`-`	报警触发条件。
notice_conf	Object of AlarmNoticeConf	是	`-`	通知配置信息。

Activation

参数	类型	是否必选	示例值	描述
activation_start	String	否	`08:00`	全天生效时间起点。24h制，精确到分。例如早上9点是"09:00"。
activation_end	String	否	`23:00`	全天生效时间终点。24h制，精确到分。例如晚上9点是"21:00"。

FilterCondition

参数	类型	是否必选	示例值	描述
type	String	否	`and`	条件类型。 expression：表达式 and：且条件 or：或条件
dimension	String	否	`aid`	条件的名称。
op	String	否	`in`	操作符。 in：包含
value	String	否	`123456`	筛选值。
values	Array of String	否	`[123456]`	筛选值，支持多个。
sub_conditions	Array of FilterCondition	否	`-`	子条件。

GroupBy

参数	类型	是否必选	示例值	描述
dimension	String	否	`path`	分组名称。

AlarmHitRule

参数	类型	是否必选	示例值	描述
type	String	是	`and`	条件类型。 expression：表达式 and：且条件 or：或条件
hit_rule_type	String	是	`threshold`	规则类型。 threshold：阈值 compare：同环比
threshold_calculate_type	String	是	`-`	阈值计算方式，是纯做加减还是做百分比。
threshold_value	Double	是	`10000`	报警阈值。
op	String	是	`gt`	比较符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于
indicator	Object of Indicator	否	`-`	阈值类型参数配置。
indicators	Array of Indicator	否	`-`	同环比类型参数配置。
sub_hit_rules	Array of AlarmHitRule	否	`-`	子规则。

AlarmNoticeConf

参数	类型	是否必选	示例值	描述
type	Array of String	否	`mail`	通知类型。 lark：飞书 mail：邮箱 dingding：钉钉 wechat：企业微信
lark_web_hooks	Array of String	否	`-`	增加飞书的webhook链接配置项。
dingding_web_hooks	Array of String	否	`-`	钉钉webhook。
wechat_web_hooks	Array of String	否	`-`	微信webhook。
alarm_receives	Array of Candidate	否	`-`	接收组。

Indicator

参数	类型	是否必选	示例值	描述
name	String	是	`crash_count`	指标定义名称，由`GetAppAlarmMetricsConf`接口获取。
value	Double	否	`10`	指标值。
recently	Long	是	`180`	指标查询时间范围，比如180min。
compare_time	Long	是	`0`	比较时间。 5：前五分钟 0：当前
start_time	Long	否	`-`	统计起始时间。
end_time	Long	否	`-`	统计终止时间。

Candidate

参数	类型	是否必选	示例值	描述
is_group	Boolean	否	`true`	是否接收组。
user_name	String	否	`-`	单个用户。
email	String	否	`-`	群组。
group_name	String	否	`-`	群组名。
group_id	Integer	否	`123`	接收组ID。

返回参数

参数	类型	示例值	描述
error_msg	String	`-`	错误信息，成功为空。
error_no	Long	`0`	错误码，成功为0。

请求示例

POST https://open.volcengineapi.com?Action=SetAppAlarmRule&Version=2022-10-12
{
    "name": "测试报警0401",
    "description": "",
    "alarm_level": "fatal",
    "filter": {
        "type": "and",
        "sub_conditions": [
            {
                "dimension": "aid",
                "type": "expression",
                "op": "in",
                "values": [
                    "123456"
                ]
            }
        ]
    },
    "hit_rule": {
        "type": "and",
        "sub_hit_rules": [
            {
                "type": "expression",
                "hit_rule_type": "threshold",
                "indicator": {
                    "name": "crash_count",
                    "recently": 180,
                    "compare_time": 0
                },
                "threshold_calculate_type": "",
                "threshold_value": 1,
                "op": "gte"
            }
        ]
    },
    "check_cycle": 5,
    "activations": [
        {
            "activation_start": "00:00",
            "activation_end": "23:59"
        }
    ],
    "group_bys": [
        {
            "dimension": "os"
        }
    ],
    "notice_conf": {
        "type": [
            "lark"
        ],
        "lark_web_hooks": [
            "https://open.feishu.cn/open-apis/bot/v2/hook/f135"
        ]
    },
    "monitor_type": [
        "crash"
    ],
    "id": 12345
}

返回示例

{
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Activation

FilterCondition

GroupBy

AlarmHitRule

AlarmNoticeConf

Indicator

Candidate

返回参数

请求示例

返回示例

错误码