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

文档中心

导航

GetAppAlarmHistory

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

获取App报警历史。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
aid	Long	是	`123456`	应用ID。
filters	Object of Condition	否	`-`	筛选条件，可以指定多个键值对来筛选数据。
start_time	Long	是	`1665417600`	开始时间。
end_time	Long	是	`1666417600`	终止时间。
query_key	String	否	`test`	报警事件名模糊搜索，不填默认全部。
page_size	Long	否	`2`	分页条数，不传默认10。
page_no	Long	否	`1`	起始页码为1。
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
order_by	String	否	`-`	排序方式，默认按报警时间倒序排列。

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

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

AlarmEventPage

参数	类型	示例值	描述
data	Array of AlarmEvent	`-`	报警历史。
curr_page	Long	`1`	当前页码。
total_cnt	Long	`99`	总条数。
total_page	Long	`10`	总页数。

AlarmEvent

参数	类型	示例值	描述
id	Long	`1`	报警ID。
rule_id	Long	`1`	报警任务ID。
rule_name	String	`test`	报警名称。
occur_time	String	`-`	报警事件发生时间。
notify_content	String	`-`	报警内容。
alarm_level	String	`-`	报警级别。 warning fatal
notify_types	Array of String	`[mail]`	通知方式。
handle_status	Long	`-`	处理状态。
ack_status	Long	`0`	ACK状态。 0：可确认 1：可重置
ack_time	String	`-`	ACK时间。
url	String	`-`	链接。
operators	Array of String	`-`	报警创建人ID列表。
operators_info	Array of UserProfile	`-`	报警创建人具体信息。
filter_info	Object of FilterCondition	`-`	报警任务条件。
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：自定义异常异常类型。
hit_rule	Object of AlarmHitRule	`-`	报警任务规则配置。
rule_brief	String	`-`	报警事件对应的规则的简述。
alarm_receives	Array of Candidate	`-`	报警邮件接收组信息。

UserProfile

参数	类型	示例值	描述
id	Long	`1`	用户ID。
username	String	`test_name`	用户名称。
email	String	`test@test.com`	用户邮箱。

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	`-`	子条件。

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	`-`	子规则。

Candidate

参数	类型	示例值	描述
is_group	Boolean	`true`	是否接收组。
user_name	String	`test`	单个用户的用户名。
email	String	`test@test.com`	用户邮箱。
group_name	String	`test`	群组接收组名。
group_id	Integer	`1`	接收组ID。

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	`-`	统计终止时间。

请求示例

POST https://open.volcengineapi.com?Action=GetAppAlarmHistory&Version=2022-10-12
{
    "aid":123456,
    "start_time":1679155200,
    "end_time":1679295939,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"rule_id",
                "type":"expression",
                "op":"in",
                "values":[
                    "717"
                ]
            }
        ]
    },
    "query_key":"",
    "monitor_types":[
        "crash"
    ],
    "page_no":1,
    "page_size":1
}

返回示例

{
    "err_detail": "",
    "data": {
        "data": [
            {
                "id": 12345,
                "rule_id": 717,
                "rule_name": "测试报警0401",
                "occur_time": "2023-02-13 11:56:48",
                "notify_content": "分组1：操作系统名称：Android\n崩溃次数最近180分钟内>=1，当前值5\n任务间隔：5分钟\n筛选条件：\n",
                "alarm_level": "fatal",
                "notify_types": [
                    "lark"
                ],
                "handle_status": 0,
                "ack_status": 0,
                "ack_time": "2022-04-27 23:57:13",
                "operators": [
                    "1"
                ],
                "operators_info": [
                    {
                        "id": 1,
                        "username": "admin-1",
                        "display_name": "admin-1",
                        "email": "",
                        "head_url": "",
                        "sso_user_id": "",
                        "auth_level": "admin",
                        "title": ""
                    }
                ],
                "filter_info": {
                    "type": "and",
                    "dimension": "",
                    "op": "",
                    "sub_conditions": [
                        {
                            "type": "expression",
                            "dimension": "aid",
                            "op": "in",
                            "values": [
                                "123456"
                            ]
                        }
                    ]
                },
                "rule_brief": "任务间隔：5分钟\n筛选条件：\n报警分组：操作系统名称\n最近180分钟内，崩溃次数 阈值>=1",
                "monitor_type":"crash",
                "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": []
                }
            }
        ],
        "total_cnt": 312,
        "total_page": 312,
        "curr_page": 1
    },
    "error_msg": "",
    "error_no": 0
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

AlarmEventPage

AlarmEvent

UserProfile

FilterCondition

AlarmHitRule

Candidate

Indicator

请求示例

返回示例

错误码