文档中心

PCAlarmHistory

最近更新时间：2023.08.04 14:28:19

首次发布时间：2022.11.15 20:38:48

调用PCAlarmHistory接口查看报警历史。

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`PCAlarmHistory`	请求名称。
Version	String	是	`2022-10-28`	请求版本。

Body

参数	类型	是否必选	示例值	描述
common	object of common	是	-	通用参数。
id	i64	是	`1`	报警规则ID。
page_size	i32	是	`3`	每页显示历史记录数。
page_num	i32	是	`1`	返回页码号
time_filter	object of time_filter	是	-	时间过滤。

common

参数	类型	是否必选	示例值	描述
aid	i64	是	`12345`	App ID。
env	string	否	`crash`	环境信息。
os	string	是	`pc`	系统。

time_filter

参数	类型	是否必选	示例值	描述
start_time	i32	是	`1655308800`	开始时间。
granularity	i32	否	`3`	聚合颗粒度，单位为秒。
end_time	i32	是	`1655971939`	结束时间。

返回参数

参数	类型	示例值	描述
data	object of data	-	返回内容。
errmsg	string	`""`	错误信息，成功为空。
errno	i32	`200`	错误码，成功为200。

data

参数	类型	示例值	描述
alarm_histories	array of alarm_histories	-	报警历史列表。
count	i32	`30`	报警总数。

alarm_histories

参数	类型	示例值	描述
id	i64	`1`	报警ID。
alarm_param	object of alarm_param	-	报警参数。
alarm_time	i64	`1655391060`	报警发生时间。
alarm_content	string	`最近180分钟test_service_gyf/xxxxxx`	报警内容
alarm_result	object of alarm_result	-	报警结果。
operator	string	`zhangsan`	最近更新人。

alarm_param

参数	类型	示例值	描述
id	i64	`1`	创建时不传，更新时传。
name	string	`minitor`	报警名称。
desc	string	`新的报警`	报警说明。
is_close	i8	`1`	是否关闭报警。 0：开启 1：关闭
category	string	`pc_flexible`	报警类型。
category_label	string	`""`	报警类型展示名称。
alarm_level	string	`Warn`	报警级别。 Notice Warn Fatal
strategy_list	array of strategy_list	-	报警策略。
strategy_op	string	`and`	多策略关系。 and or
interval_seconds	i32	`300`	报警间隔，最短5分钟。
alarm_period	object of alarm_period	-	报警时间。
notify_config	object of notify_config	-	报警通知。
pct_avoid_spike	object of pct_avoid_spike	-	pct报警参数。

alarm_result

参数	类型	示例值	描述
is_alarm	boolean	`true`	是否报警。
strategy_result_list	array of strategy_result_list	-	分策略报警结果。

strategy_list

参数	类型	示例值	描述
id	string	`9018754602-1655285699772`	当新建报警策略的时候前端生成，用于后端画趋势图。
measure	object of measure	-	指标集合。
filter_list	array of filter_list	-	过滤条件。
alarm_strategy_type	string	`threshold`	指标计算策略阈值：threshold 同比：cmp_last_n_day
daily_compare_count	i32	`60`	同比支持过去x分钟。
alarm_threshold	double	`10`	报警阈值。
threshold_cmp_op	string	`gt`	报警阈值的op。 gt gte lt lte abs_gt abs_gte
alarm_sample_threshold	double	`3`	样本数量阈值。
alarm_window_size	i64	`180`	时间窗口，单位为秒。
group_bys	array of group_bys	-	报警的分组。
sample_metric	object of sample_metric	-	简单指标。
user_metric	object of user_metric	-	自定义指标。

alarm_period

参数	类型	示例值	描述
start_time	i32	`0`	开始时间，单位为秒。
end_time	i32	`86399`	结束时间，单位为秒。

notify_config

参数	类型	示例值	描述
notify_types	array of string	`["mail"]`	报警通知方式。 lark mail wechat dingding
notify_lark_webhooks	array of string	`["http://lark/url"]`	飞书通知webhook列表。
notify_groups	array of string	`[1,23]`	邮件接收组ID列表。
notify_wechat_webhooks	array of string	`["http://wechat/url"]`	企业微信通知webhook列表。
notify_dingding_webhooks	array of string	`["http://dingding/url"]`	钉钉通知webhook列表。
upgrade_groups	array of string	`[1,23]`	升级邮件接收组ID列表。

pct_avoid_spike

参数	类型	示例值	描述
pct	i8	`10`	10：pct10 20：pct20
alarm_threshold	double	`10`	报警阈值。

strategy_result_list

参数	类型	示例值	描述
is_alarm	boolean	`true`	是否报警。
title	string	`崩溃数`	指标名称。
groupField	string	`os`	分组报警时的分组字段。
group_result_list	array of group_result_list	-	分组报警结果

measure

参数	类型	示例值	描述
type	string	`monomial`	指标类型。 monomial polynomial
raw_measure_list	array of raw_measure_list	-	具体查询指标。
name	string	`崩溃影响用户数`	指标名称。
customId	string	`xe3ejx98`	前端用于还原页面。

参数	类型	示例值	描述
op	string	`in`	过滤方式。
filter_name	string	`cpu`	用于表明filter的哪个维度。
values	array of string	`["intel", "Qualcomm"]`	过滤值。

group_bys

参数	类型	示例值	描述
group_by_name	string	`os`	分组维度。
label	string	`OS`	分组展示名称。

sample_metric

参数	类型	示例值	描述
type	string	`monomial`	指标类型。 monomial polynomial
raw_measure_list	array of raw_measure_list	-	具体查询指标。
name	string	`崩溃影响用户数`	指标名称。
customId	string	`xe3ejx98`	前端用于还原页面。

user_metric

参数	类型	示例值	描述
type	string	`monomial`	指标类型。 monomial polynomial
raw_measure_list	array of raw_measure_list	-	具体查询指标。
name	string	`崩溃影响用户数`	指标名称。
customId	string	`xe3ejx98`	前端用于还原页面。

group_result_list

参数	类型	示例值	描述
is_alarm	boolean	`true`	是否报警。
group_value	string	`""`	分组值，比如国家分组的中国，如果不是分组报警则不返回。
alarm_tag_list	array of alarm_tag_list	-	计算相关统计值。
alarm_value	object of alarm_value	-	报警值。

raw_measure_list

参数	类型	示例值	描述
measure_name	string	`"{\metric\:\pc_flexible.count\,\event_dimension\:\pc_flexible.event_name\,\event_name\:\test_service_gyf\}"`	具体的指标计算值。
filter_list	array of filter_list	-	过滤条件。
event_name	string	`test_service_gyf`	前端传了此参数, 后端没有用到. 但是还原图表的时候是从这个字段读的事件名。

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

alarm_value

参数	类型	示例值	描述
current_value	object of current_value	-	当前值。
last_n_day_value	object of last_n_day_value	-	最近n天的值。
last_period_value	object of last_period_value	-	最近一段时间的值。
delta_ratio	object of delta_ratio	-	无意义。
alarm_threshold	object of alarm_threshold	-	报警阈值。
sample_count	object of sample_count	-	简单指标数量。
user_count	object of user_count	-	自定义指标数量
window_size	object of window_size	-	时间窗口。

current_value

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

last_n_day_value

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

last_period_value

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

delta_ratio

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

alarm_threshold

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

sample_count

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

user_count

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理加时间单位。

window_size

参数	类型	示例值	描述
label	string	`样本量`	展示标签。
value	double	`30`	具体值。
format_value	string	`30`	格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。

示例

请求示例

POST /?Action=PCAlarmHistory&Version=2022-10-28 
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "env": "crash",
        "site_type": ""
    },
    "id": 1,
    "page_size": 3,
    "page_num": 1,
    "time_filter": {
        "start_time": 1655308800,
        "end_time": 1655971939,
        "granularity": 3
    }
}

正常返回示例

{
    "data": {
        "count": 30,
        "alarm_histories": [
            {
                "alarm_content": "最近180分钟test_service_gyf/xxxxxx",
                "alarm_param": {
                    "name": "minitor",
                    "desc": "新的报警",
                    "is_close": 1,
                    "category": "pc_flexible",
                    "alarm_level": "Warn",
                    "strategy_list": [
                        {
                            "id": "9018754602-1655285699772",
                            "alarm_strategy_type": "threshold",
                            "alarm_threshold": 10,
                            "threshold_cmp_op": "gt",
                            "alarm_window_size": 180,
                            "alarm_sample_threshold": 3,
                            "group_bys": [
                                {
                                    "group_by_name": "os",
                                    "label": "OS"
                                }
                            ],
                            "daily_compare_count": 60,
                            "filter_list": [
                                {
                                    "op": "in",
                                    "filter_name": "cpu",
                                    "values": [
                                        "intel",
                                        "Qualcomm"
                                    ]
                                }
                            ]
                        }
                    ],
                    "strategy_op": "and",
                    "interval_seconds": 300,
                    "alarm_period": {
                        "start_time": 156,
                        "end_time": 86399
                    },
                    "id": 1,
                    "category_label": "sitting",
                    "notify_config": {
                        "notify_lark_webhooks": [
                            "http://lark/url"
                        ],
                        "notify_groups": [
                            1,
                            23
                        ],
                        "notify_wechat_webhooks": [
                            "http://wechat/url"
                        ],
                        "notify_dingding_webhooks": [
                            "http://dingding/url"
                        ],
                        "notify_types": [
                            "mail"
                        ],
                        "upgrade_groups": [
                            1,
                            23
                        ]
                    }
                },
                "id": 1,
                "alarm_result": {
                    "strategy_result_list": [
                        {
                            "groupField": "os",
                            "is_alarm": true,
                            "title": "崩溃数",
                            "group_result_list": [
                                {
                                    "group_value": "",
                                    "alarm_tag_list": [
                                        {
                                            "value": 30,
                                            "format_value": "30",
                                            "label": "样本量"
                                        }
                                    ],
                                    "is_alarm": true
                                }
                            ]
                        }
                    ],
                    "is_alarm": true
                },
                "alarm_time": 1655391060,
                "operator": "zhangsan"
            }
        ]
    },
    "errno": 200,
    "errmsg": ""
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2018****22D30",
        "Action": "PCAlarmHistory",
        "Version": "2022-10-28",
        "Service": "***",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

应用性能监控全链路版

PCAlarmHistory

请求参数

Query

Body

common

time_filter

返回参数

data

alarm_histories

alarm_param

alarm_result

strategy_list

alarm_period

notify_config

pct_avoid_spike

strategy_result_list

measure

filter_list

group_bys

sample_metric

user_metric

group_result_list

raw_measure_list

alarm_tag_list

alarm_value

current_value

last_n_day_value

last_period_value

delta_ratio

alarm_threshold

sample_count

user_count

window_size

示例

请求示例

正常返回示例

异常返回示例