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

文档中心

导航

PCAlarmAdd

最近更新时间：2024.07.15 14:26:48首次发布时间：2022.11.15 20:38:48

新增报警。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
common	Object of CommonParams	是	`-`	通用参数。
alarm_param_list	Array of AlarmParam	是	`-`	报警参数。

CommonParams

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

AlarmParam

参数	类型	是否必选	示例值	描述
id	Long	否	`1`	创建时不传，更新时传。
desc	String	是	`新的报警`	报警说明。
name	String	是	`minitor`	报警名称。
category	String	是	`pc_flexible`	报警类型。
is_close	Integer	是	`1`	是否关闭报警。 0：开启 1：关闭
alarm_level	String	是	`Warn`	报警级别。 Notice Warn Fatal
strategy_op	String	是	`and`	多策略关系。 and or
alarm_period	Object of AlarmPeriod	是	`-`	报警时间段。
notify_config	Object of NotifyConfig	否	`-`	报警通知。
strategy_list	Array of AlarmStrategy	是	`-`	报警策略。
category_label	String	否	`""`	报警类型展示名称。
interval_seconds	Integer	是	`300`	报警间隔，最短5分钟。

AlarmPeriod

参数	类型	是否必选	示例值	描述
end_time	Integer	是	`86399`	报警结束时间，单位秒。
start_time	Integer	是	`0`	报警开始时间，单位秒。

NotifyConfig

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

AlarmStrategy

参数	类型	是否必选	示例值	描述
id	String	是	`9018754602-1655285699772`	当新建报警策略的时候前端生成，用于后端画趋势图。
measure	Object of FlexMeasure	是	`-`	指标集合。
group_bys	Array of FlexGroupBy	否	`-`	报警的分组。
filter_list	Array of FlexFilter	否	`-`	过滤条件。
alarm_threshold	Double	是	`10`	报警阈值。
threshold_cmp_op	String	是	`gt`	报警阈值的op。 gt gte lt lte abs_gt abs_gte
alarm_window_size	Long	是	`180`	时间窗口，单位s。
alarm_strategy_type	String	是	`threshold`	指标计算策略。阈值：threshold 同比：cmp_last_n_day
daily_compare_count	Integer	否	`60`	同比支持过去x分钟。
alarm_sample_threshold	Double	否	`3`	样本数量阈值。

FlexMeasure

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

FlexGroupBy

参数	类型	是否必选	示例值	描述
label	String	否	`OS`	分组展示名称。
group_by_name	String	是	`os`	分组维度。

FlexFilter

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

FlexRawMeasure

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

返回参数

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

AddAlarmResponseData

参数	类型	示例值	描述
ids	Array of Long	`[1]`	报警规则ID列表。

请求示例

POST https://open.volcengineapi.com?Action=PCAlarmAdd&Version=2022-10-28
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "site_type": "",
        "env": "crash"
    },
    "alarm_param_list": [
        {
            "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"
                        }
                    ],
                    "filter_list": [
                        {
                            "op": "in",
                            "filter_name": "cpu",
                            "values": [
                                "intel",
                                "Qualcomm"
                            ]
                        }
                    ],
                    "daily_compare_count": 60
                }
            ],
            "strategy_op": "and",
            "interval_seconds": 300,
            "alarm_period": {
                "start_time": 776,
                "end_time": 86399
            },
            "id": 1,
            "category_label": "",
            "notify_config": {
                "notify_wechat_webhooks": [
                    "http://wechat/url"
                ],
                "notify_types": [
                    "mail"
                ],
                "notify_dingding_webhooks": [
                    "http://dingding/url"
                ],
                "notify_groups": [
                    1,
                    23
                ],
                "notify_lark_webhooks": [
                    "http://lark/url"
                ],
                "upgrade_groups": [
                    1,
                    23
                ]
            }
        }
    ]
}

返回示例

{
    "data": {
        "ids": []
    },
    "errmsg": "",
    "errno": 200
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

CommonParams

AlarmParam

AlarmPeriod

NotifyConfig

AlarmStrategy

FlexMeasure

FlexGroupBy

FlexFilter

FlexRawMeasure

返回参数

AddAlarmResponseData

请求示例

返回示例

错误码