You need to enable JavaScript to run this app.
导航
PCAlarmHistory
最近更新时间:2024.06.18 17:13:11首次发布时间:2022.11.15 20:38:48

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=PCAlarmHistory&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json

请求参数

Query

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

Body

参数类型是否必选示例值描述
commonObject of CommonParams-通用参数。
idLong1报警规则ID。
page_sizeInteger3每页显示历史记录数。
page_numInteger1返回页码号
time_filterObject of TimeFilter-时间过滤。

CommonParams

参数类型是否必选示例值描述
osStringpc系统。
aidLong12345App ID。
envStringcrash环境信息。

TimeFilter

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

返回参数

参数类型示例值描述
dataObject of AlarmHistoryList-返回内容。
errmsgString""错误信息,成功为空。
errnoInteger200错误码,成功为200。

AlarmHistoryList

参数类型示例值描述
countInteger30报警总数。
alarm_historiesArray of AlarmHistory-报警历史列表。

AlarmHistory

参数类型示例值描述
idLong1报警ID。
operatorStringzhangsan最近更新人。
alarm_timeLong1655391060报警发生时间。
alarm_paramObject of AlarmParam-报警参数。
alarm_resultObject of AlarmResult-报警计算结果。
alarm_contentString最近180分钟test_service_gyf/xxxxxx报警内容。

AlarmParam

参数类型示例值描述
idLong1创建时不传,更新时传。
descString新的报警报警说明。
nameStringminitor报警名称。
categoryStringpc_flexible报警类型。

is_close

Integer

1

是否关闭报警。

  • 0:开启
  • 1:关闭

alarm_level

String

Warn

报警级别。

  • Notice
  • Warn
  • Fatal

strategy_op

String

and

多策略关系。

  • and
  • or
alarm_periodObject of AlarmPeriod-报警时间段。
notify_configObject of NotifyConfig-报警通知。
strategy_listArray of AlarmStrategy-报警策略。
category_labelString""报警类型展示名称。
interval_secondsInteger300报警间隔,最短5分钟。

AlarmResult

参数类型示例值描述
is_alarmBooleantrue是否报警。
strategy_result_listArray of StrategyResult-分策略报警结果。

AlarmPeriod

参数类型示例值描述
end_timeInteger86399报警结束时间,单位秒。
start_timeInteger0报警开始时间,单位秒。

NotifyConfig

参数类型示例值描述

notify_types

Array of String

["mail"]

报警通知方式。

  • lark
  • mail
  • wechat
  • dingding
notify_groupsArray of Long[1,23]邮件接收组ID列表。
upgrade_groupsArray of Long[1,23]升级邮件接收组ID列表。
notify_lark_webhooksArray of String["http://lark/url"]飞书通知webhook列表。
notify_wechat_webhooksArray of String["http://wechat/url"]企业微信通知webhook列表。
notify_dingding_webhooksArray of String["http://dingding/url"]钉钉通知webhook列表。

AlarmStrategy

参数类型示例值描述
idString9018754602-1655285699772当新建报警策略的时候前端生成,用于后端画趋势图。
measureObject of FlexMeasure-指标集合。
group_bysArray of FlexGroupBy-报警的分组。
filter_listArray of FlexFilter-过滤条件。
alarm_thresholdDouble10报警阈值。

threshold_cmp_op

String

gt

报警阈值的op。

  • gt
  • gte
  • lt
  • lte
  • abs_gt
  • abs_gte
alarm_window_sizeLong180时间窗口,单位s。

alarm_strategy_type

String

threshold

指标计算策略。

  • 阈值:threshold
  • 同比:cmp_last_n_day
daily_compare_countInteger60同比支持过去x分钟。
alarm_sample_thresholdDouble3样本数量阈值。

StrategyResult

参数类型示例值描述
titleString崩溃数指标名称。
is_alarmBooleantrue是否报警。
groupFieldStringos分组报警时的分组字段、
group_result_listArray of GroupResult-分组报警结果。

FlexMeasure

参数类型示例值描述
nameString崩溃影响用户数指标名称。

type

String

monomial

指标类型。

  • monomial
  • polynomial
customIdStringxe3ejx98前端用于还原页面。
raw_measure_listArray of FlexRawMeasure-具体查询指标。

FlexGroupBy

参数类型示例值描述
labelStringOS分组展示名称。
group_by_nameStringos分组维度。

FlexFilter

参数类型示例值描述
opStringin过滤方式。
valuesArray of String["intel", "Qualcomm"]过滤值。
filter_nameStringcpu用于表明filter的哪个维度。

GroupResult

参数类型示例值描述
is_alarmBooleantrue是否报警。
group_valueString""分组值,比如国家分组的中国,如果不是分组报警则不返回。
alarm_tag_listArray of Tag-计算相关统计值。

FlexRawMeasure

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

Tag

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

请求示例

POST https://open.volcengineapi.com?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": ""
}

错误码

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