You need to enable JavaScript to run this app.
导航
SetAppAlarmRule
最近更新时间:2024.06.20 17:40:46首次发布时间:2022.11.18 17:53:52

调用SetAppAlarmRule接口新建或更新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

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

Body

参数类型是否必选示例值描述
idLong1报警规则ID,如果是新建的可以不传。
nameStringtask_test规则名称。
descriptionStringalarm 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_cycleLong5监测周期,分钟为单位,瞬时报警请填0。
activationsArray of Activation-多个时间段。
filterObject of FilterCondition-报警指标筛选条件。
group_bysArray of GroupBy-报警分组条件。
hit_ruleObject of AlarmHitRule-报警触发条件。
notice_confObject of AlarmNoticeConf-通知配置信息。

Activation

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

FilterCondition

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

type

String

and

条件类型。

  • expression:表达式
  • and:且条件
  • or:或条件
dimensionStringaid条件的名称。

op

String

in

操作符。

  • in:包含
valueString123456筛选值。
valuesArray of String[123456]筛选值,支持多个。
sub_conditionsArray of FilterCondition-子条件。

GroupBy

参数类型是否必选示例值描述
dimensionStringpath分组名称。

AlarmHitRule

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

type

String

and

条件类型。

  • expression:表达式
  • and:且条件
  • or:或条件

hit_rule_type

String

threshold

规则类型。

  • threshold:阈值
  • compare:同环比
threshold_calculate_typeString-阈值计算方式,是纯做加减还是做百分比。
threshold_valueDouble10000报警阈值。

op

String

gt

比较符。

  • gt:大于
  • gte:大于等于
  • lt:小于
  • lte:小于等于
  • eq:等于
indicatorObject of Indicator-阈值类型参数配置。
indicatorsArray of Indicator-同环比类型参数配置。
sub_hit_rulesArray of AlarmHitRule-子规则。

AlarmNoticeConf

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

type

Array of String

mail

通知类型。

  • lark:飞书
  • mail:邮箱
  • dingding:钉钉
  • wechat:企业微信
lark_web_hooksArray of String-增加飞书的webhook链接配置项。
dingding_web_hooksArray of String-钉钉webhook。
wechat_web_hooksArray of String-微信webhook。
alarm_receivesArray of Candidate-接收组。

Indicator

参数类型是否必选示例值描述
nameStringcrash_count指标定义名称,由GetAppAlarmMetricsConf接口获取。
valueDouble10指标值。
recentlyLong180指标查询时间范围,比如180min。

compare_time

Long

0

比较时间。

  • 5:前五分钟
  • 0:当前
start_timeLong-统计起始时间。
end_timeLong-统计终止时间。

Candidate

参数类型是否必选示例值描述
is_groupBooleantrue是否接收组。
user_nameString-单个用户。
emailString-群组。
group_nameString-群组名。
group_idInteger123接收组ID。

返回参数

参数类型示例值描述
error_msgString-错误信息,成功为空。
error_noLong0错误码,成功为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
}

错误码

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