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

文档中心

导航

GetAppAlarmRuleList

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

获取App报警任务列表。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
aid	Long	否	`123456`	应用ID。
rule_id	Long	否	`1`	报警任务ID。
monitor_types	Array of 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
status	Array of Integer	否	`1`	任务状态。 1：启用 2：关闭
query_key	String	否	`test`	搜索关键字，可按配置，接收组关键字搜索。
page_size	Long	否	`2`	分页条数，不传默认10。
page_no	Long	否	`1`	起始页码为1。
self	Integer	否	`0`	是否只查看自己创建的规则。 1：只查看自己 0：查看全部

返回参数

参数	类型	示例值	描述
data	Object of AlarmRuleInfoPage	`-`	报警任务列表。
error_msg	String	`-`	错误信息，成功为空。
error_no	Long	`0`	错误码，成功为0。

AlarmRuleInfoPage

参数	类型	示例值	描述
data	Array of AlarmRule	`-`	报警任务。
curr_page	Long	`1`	当前页码。
total_cnt	Long	`1`	总条数。
total_page	Long	`1`	总页数。

AlarmRule

参数	类型	示例值	描述
id	Long	`12345`	报警规则ID。如果是新建的可以不传。
name	String	`测试报警001`	规则名称。
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：自定义异常异常类型。
alarm_level	String	`fatal`	报警级别。 warning fatal
check_cycle	Long	`5`	监测周期，单位为分钟，瞬时报警请填0。
activation_start	String	`08:00`	全天生效时间起点，24h制，精确到分。例如，早上9点为"09:00"。
activation_end	String	`23:00`	全天生效时间终点，24h制，精确到分。例如，晚上9点为"21:00"。
activations	Array of Activation	`-`	多个时间段。
status	Integer	`1`	报警状态。 1：启用 2：停用 0：删除
filter	Object of FilterCondition	`-`	报警指标筛选条件。
group_bys	Array of GroupBy	`-`	报警分组条件。
hit_rule	Object of AlarmHitRule	`-`	报警触发条件。
notice_conf	Object of AlarmNoticeConf	`-`	通知配置信息。
brief	String	`任务间隔：5分钟\n筛选条件：\n报警分组：操作系统名称\n最近180分钟内，崩溃次数阈值>=1`	概述信息。
count	Long	`76267`	报警次数。
update_at	String	`2023-02-06 15:59:38`	更新事件的时间，格式为“yyyy-MM-dd HH:mm:ss”。
recently_occur_time	String	`2023-02-13 10:46:48`	最近发生时间，没有为空字符串。
ack_time	String	`2022-04-28 17:57:13`	ACK时间。
ack_status	Integer	`0`	ACK状态。 0：未ACK 1：ACK

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。

请求示例

POST https://open.volcengineapi.com?Action=GetAppAlarmRuleList&Version=2022-10-12
{
    "monitor_types":[
        "crash"
    ],
    "query_key":"测试报警",
    "status":[

    ],
    "page_no":1,
    "page_size":1
}

返回示例

{
    "err_detail": "",
    "data": {
        "data": [
            {
                "id": 717,
                "name": "测试报警0401",
                "monitor_type": "crash",
                "alarm_level": "fatal",
                "check_cycle": 5,
                "activations": [
                    {
                        "activation_start": "00:00",
                        "activation_end": "23:59",
                        "activation_start_stamp": 1541174400,
                        "activation_end_stamp": 1541260740
                    }
                ],
                "activation_start": "08:00",
                "activation_end": "08:00",
                "status": 1,
                "callback_url": "",
                "filter": {
                    "type": "and",
                    "dimension": "",
                    "op": "",
                    "sub_conditions": [
                        {
                            "type": "expression",
                            "dimension": "aid",
                            "op": "in",
                            "values": [
                                "187277"
                            ]
                        }
                    ]
                },
                "group_bys": [
                    {
                        "dimension": "os"
                    }
                ],
                "hit_rule": {
                    "type": "and",
                    "hit_rule_type": "",
                    "threshold_calculate_type": "",
                    "threshold_value": 0,
                    "op": "",
                    "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",
                            "hit_metric": []
                        }
                    ],
                    "hit_metric": []
                },
                "notice_conf": {
                    "type": [
                        "lark"
                    ],
                    "lark_web_hooks": [
                        "https://open.feishu.cn/open-apis/bot/v2/hook/2a****"
                    ],
                    "dingding_web_hooks": [],
                    "wechat_web_hooks": []
                },
                "brief": "任务间隔：5分钟\n筛选条件：\n报警分组：操作系统名称\n最近180分钟内，崩溃次数 阈值>=1",
                "count": 84947,
                "update_at": "2023-03-09 13:11:40",
                "recently_occur_time": "2023-03-20 10:28:53",
                "ack_status": 0,
                "ack_time": "2023-03-02 09:43:21"
            }
        ],
        "total_cnt": 10,
        "total_page": 10,
        "curr_page": 1
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

返回参数

AlarmRuleInfoPage

AlarmRule

Activation

FilterCondition

GroupBy

AlarmHitRule

AlarmNoticeConf

Indicator

Candidate

请求示例

返回示例

错误码