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

文档中心

导航

PCAlarmRuleList

最近更新时间：2025.03.07 15:02:05首次发布时间：2022.11.15 20:38:48

查看报警列表。

请求说明

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

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
common	Object of CommonParams	是	`-`	通用参数。
status	Integer	否	`0`	监控状态。 0：status_open 1：status_close
self	Integer	否	`1`	管理状态。 0：全部不传 1：我管理的
category_list	Array of String	否	`[pc_crash]`	报警类型。 pc_flexible pc_crash
keyword	String	否	`alarm`	搜索名称关键字。
page_size	Integer	是	`3`	每页规则数。
page_num	Integer	是	`1`	返回页码号。

CommonParams

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

返回参数

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

AlarmRuleList

参数	类型	示例值	描述
count	Integer	`30`	报警规则总数。
alarm_rule_list	Array of AlarmDetail	`[ {"alarm_param":{...},"created_by": "root", "updated_by": "root" },...]`	报警规则列表。

AlarmDetail

参数	类型	示例值	描述
created_by	String	`zhangsan`	创建人。
updated_by	String	`lisi`	更新人。
alarm_param	Object of AlarmParam	`{id: 285, name: "lc测试", desc: "测试报警参数", is_close: 0, category: "pc_crash_sink_chtb",…}`	报警配置。
created_time	Long	`1667550612`	创建时间。
updated_time	Long	`1667550612`	更新时间。
ack_until_time	Long	`1667550612`	ACK到期时间。
last_execute_time	Long	`1668550612`	上次执行时间。
next_trigger_time	Long	`1667550612`	下次触发时间。
num_of_alarm_in_last_one_month	Integer	`1`	上个月触发次数。

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\"}"`	具体的指标计算值。

请求示例

POST https://open.volcengineapi.com?Action=PCAlarmRuleList&Version=2022-10-28
{
    "common": {
        "aid": 12345,
        "os": "pc",
        "env": "crash",
        "site_type": "nuclear"
    },
    "page_size": 3,
    "page_num": 1,
    "keyword": "alarm",
    "self": 1,
    "status": 250,
    "category_list": [
        "pc_crash"
    ]
}

返回示例

{
    "data": {
        "count": 30,
        "alarm_rule_list": [
            {
                "created_by": "zhangsan",
                "updated_by": "lisi",
                "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"
                                }
                            ],
                            "filter_list": [
                                {
                                    "op": "in",
                                    "filter_name": "cpu",
                                    "values": [
                                        "intel",
                                        "Qualcomm"
                                    ]
                                }
                            ],
                            "daily_compare_count": 60
                        }
                    ],
                    "strategy_op": "and",
                    "interval_seconds": 300,
                    "alarm_period": {
                        "start_time": 820,
                        "end_time": 86399
                    },
                    "category_label": "",
                    "notify_config": {
                        "notify_dingding_webhooks": [
                            "http://dingding/url"
                        ],
                        "notify_lark_webhooks": [
                            "http://lark/url"
                        ],
                        "notify_wechat_webhooks": [
                            "http://wechat/url"
                        ],
                        "upgrade_groups": [
                            1,
                            23
                        ],
                        "notify_groups": [
                            1,
                            23
                        ],
                        "notify_types": [
                            "mail"
                        ]
                    },
                    "id": 1
                },
                "created_time": 1667550612,
                "updated_time": 1667550612,
                "ack_until_time": 1667550612,
                "last_execute_time": 1668550612,
                "next_trigger_time": 1667550612,
                "num_of_alarm_in_last_one_month": 1
            }
        ]
    },
    "errmsg": "",
    "errno": 200
}

错误码

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

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

CommonParams

返回参数

AlarmRuleList

AlarmDetail

AlarmParam

AlarmPeriod

NotifyConfig

AlarmStrategy

FlexMeasure

FlexGroupBy

FlexFilter

FlexRawMeasure

请求示例

返回示例

错误码