You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
合作与生态
支持与服务
开发者
了解我们
导航

PCAlarmHistory

更新时间:2022.11.18 16:20:56

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

请求参数

Query

参数类型是否必选示例值描述
ActionStringPCAlarmHistory请求名称
VersionString2022-10-28请求版本

Body

参数类型是否必选示例值描述
commonobject of common-通用参数
idi641报警规则ID
page_sizei323每页显示历史记录数
page_numi321返回页码号
time_filterobject of time_filter-时间过滤

common

参数类型是否必选示例值描述
aidi6412345App ID
envstringcrash环境信息
osstringpc系统

time_filter

参数类型是否必选示例值描述
start_timei321655308800开始时间
granularityi323聚合颗粒度,单位为秒
end_timei321655971939结束时间

返回参数

参数类型示例值描述
dataobject of data-返回内容
errmsgstring""错误信息,成功为空
errnoi32200错误码,成功为200

data

参数类型示例值描述
alarm_historiesarray of alarm_histories-报警历史列表
counti3230报警总数

alarm_histories

参数类型示例值描述
idi641报警ID
alarm_paramobject of alarm_param-报警参数
alarm_timei641655391060报警发生时间
alarm_contentstring最近180分钟test_service_gyf/xxxxxx报警内容
alarm_resultobject of alarm_result-报警结果
operatorstringzhangsan最近更新人

alarm_param

参数类型示例值描述
idi641创建时不传,更新时传
namestringminitor报警名称
descstring新的报警报警说明
is_closei81是否关闭报警
  • 0:开启
  • 1:关闭
  • categorystringpc_flexible报警类型
    category_labelstring""报警类型展示名称
    alarm_levelstringWarn报警级别
  • Notice
  • Warn
  • Fatal
  • strategy_listarray of strategy_list-报警策略
    strategy_opstringand多策略关系
  • and
  • or
  • interval_secondsi32300报警间隔,最短5分钟
    alarm_periodobject of alarm_period-报警时间
    notify_configobject of notify_config-报警通知
    pct_avoid_spikeobject of pct_avoid_spike-pct报警参数

    alarm_result

    参数类型示例值描述
    is_alarmbooleantrue是否报警
    strategy_result_listarray of strategy_result_list-分策略报警结果

    strategy_list

    参数类型示例值描述
    idstring9018754602-1655285699772当新建报警策略的时候前端生成,用于后端画趋势图
    measureobject of measure-指标集合
    filter_listarray of filter_list-过滤条件
    alarm_strategy_typestringthreshold指标计算策略
  • 阈值:threshold
  • 同比:cmp_last_n_day
  • daily_compare_counti3260同比支持过去x分钟
    alarm_thresholddouble10报警阈值
    threshold_cmp_opstringgt报警阈值的op
  • gt
  • gte
  • lt
  • lte
  • abs_gt
  • abs_gte
  • alarm_sample_thresholddouble3样本数量阈值
    alarm_window_sizei64180时间窗口,单位为秒
    group_bysarray of group_bys-报警的分组
    sample_metricobject of sample_metric-简单指标
    user_metricobject of user_metric-自定义指标

    alarm_period

    参数类型示例值描述
    start_timei320开始时间,单位为秒
    end_timei3286399结束时间,单位为秒

    notify_config

    参数类型示例值描述
    notify_typesarray of string["mail"]报警通知方式
  • lark
  • mail
  • wechat
  • dingding
  • notify_lark_webhooksarray of string["http://lark/url"]飞书通知webhook列表
    notify_groupsarray of string[1,23]邮件接收组ID列表
    notify_wechat_webhooksarray of string["http://wechat/url"]企业微信通知webhook列表
    notify_dingding_webhooksarray of string["http://dingding/url"]钉钉通知webhook列表
    upgrade_groupsarray of string[1,23]升级邮件接收组ID列表

    pct_avoid_spike

    参数类型示例值描述
    pcti810
  • 10:pct10
  • 20:pct20
  • alarm_thresholddouble10报警阈值

    strategy_result_list

    参数类型示例值描述
    is_alarmbooleantrue是否报警
    titlestring崩溃数指标名称
    groupFieldstringos分组报警时的分组字段
    group_result_listarray of group_result_list-分组报警结果

    measure

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list-具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    filter_list

    参数类型示例值描述
    opstringin过滤方式
    filter_namestringcpu用于表明filter的哪个维度
    valuesarray of string["intel", "Qualcomm"]过滤值

    group_bys

    参数类型示例值描述
    group_by_namestringos分组维度
    labelstringOS分组展示名称

    sample_metric

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list-具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    user_metric

    参数类型示例值描述
    typestringmonomial指标类型
  • monomial
  • polynomial
  • raw_measure_listarray of raw_measure_list-具体查询指标
    namestring崩溃影响用户数指标名称
    customIdstringxe3ejx98前端用于还原页面

    group_result_list

    参数类型示例值描述
    is_alarmbooleantrue是否报警
    group_valuestring""分组值,比如国家分组的中国,如果不是分组报警则不返回
    alarm_tag_listarray of alarm_tag_list-计算相关统计值
    alarm_valueobject of alarm_value-报警值

    raw_measure_list

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

    alarm_tag_list

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    alarm_value

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

    current_value

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    last_n_day_value

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    last_period_value

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    delta_ratio

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    alarm_threshold

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    sample_count

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    user_count

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理 加时间单位

    window_size

    参数类型示例值描述
    labelstring样本量展示标签
    valuedouble30具体值
    format_valuestring30格式化后的值,暂时只有时间窗口有特殊处理,加时间单位

    示例

    请求示例

    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": "201806041104200100100232280022D30",
            "Action": "PCAlarmHistory",
            "Version": "2022-10-28",
            "Service": "***",
            "Region": "cn-north-1",
            "Error": {
                "Code": "200000",
                "Message": "参数异常"
            }
        }
    }