You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/报警/GetAlarmRuleList
GetAlarmRuleList
最近更新时间：2024.07.12 17:21:37首次发布时间：2022.11.01 11:26:01
我的收藏

获取报警任务列表。

请求说明

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是GetAlarmRuleList接口名称。当前 API 的名称为 GetAlarmRuleList。
VersionString是2022-10-12接口版本。当前 API 的版本为 2022-10-12。

Body

参数类型是否必选示例值描述
commonObject of Common否-通用参数。

self

Integer

否

1

是否返回我管理的任务列表。

  • 1：返回我管理的任务列表。
  • 0：返回全部。

category_list

Array of String

否

["pageview"]

报警类型筛选。
不填时返回全部报警类型的报警任务，非空时返回指定报警类型的报警任务，调用GetAlarmMeta接口查看取值。

keyword

String

否

test

报警任务名称模糊搜索。
不填时返回全部报警任务，填时返回任务名满足条件的报警任务。

page_numLong否1分页查询参数，用于设置当前页码。默认值：1。
page_sizeLong否30分页查询参数，用于设置每页行数。默认值：30。

Common

参数类型是否必选示例值描述
aidLong否12345应用ID。
osString否webpro服务类型。

返回参数

参数类型示例值描述
dataObject of Data-返回数据。
error_msgString""错误信息。成功为""。
error_noInteger0错误码。成功为0。

Data

参数类型示例值描述
alarm_rule_listArray of AlarmRuleList-报警任务列表。
countInteger1报警任务数。

AlarmRuleList

参数类型示例值描述
alarm_paramObject of AlarmParam-报警参数集合。
created_byStringleeac报警任务创建人。
updated_byStringleeac报警任务最近修改人。
created_timeLong1665409567报警任务创建时间。
updated_timeLong1665409567报警任务最近修改时间。
next_trigger_timeLong1665409867报警任务下次触发时间。
last_execute_timeLong0报警任务上次执行时间。
ack_until_timeLong0报警任务ACK到期时间。
num_of_alarm_in_last_one_monthInteger0报警任务最近一个月报警次数。

AlarmParam

参数类型示例值描述
idLong1报警任务ID。
nameStringtest报警任务名称。
descString-报警说明。
categoryStringpageview报警类型。调用由GetAlarmMeta接口查看取值。

alarm_level

String

warning

报警级别。

  • warning
  • fatal
strategy_listArray of StrategyList-报警策略列表。

strategy_op

String

and

多策略关系。

  • and：同时满足所有策略
  • or：满足任一策略

interval_seconds

Integer

300

报警任务执行间隔。

  • 300：5分钟
  • 600：10分钟
  • 1800：30分钟
  • 3600：60分钟
alarm_periodObject of AlarmPeriod-报警生效时间。时间范围外的报警不通知。
notify_configObject of NotifyConfig-报警通知配置。
is_avoid_spikeBooleanfalse是否屏蔽尖刺报警。
pct_avoid_spikeObject of PctAvoidSpike-pct报警参数。当开启pct报警屏蔽时必填。

StrategyList

参数类型示例值描述
measureObject of Measure-当前策略的指标集合，包括普通指标和复合指标。
filter_listArray of FilterList-报警策略筛选条件。

alarm_strategy_type

String

threshold

报警策略类型。

  • threshold：阈值报警
  • cmp_last_n_day：比值报警

daily_compare_count

Integer

5

上一周期与当前周期的时间间隔。
当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。

alarm_thresholdDouble10报警阈值。

threshold_cmp_op

String

gt

报警阈值的op，策略符号。

  • 可选值为比值报警时，取值为gt、lt
  • 可选值为阈值报警时，取值为lt、lte、gt、gte
alarm_user_thresholdDouble1用户数阈值。
alarm_sample_thresholdDouble1样本量阈值。
alarm_window_sizeLong180报警任务查询时间窗口，表示最近X分钟。单位为分钟。
group_bysArray of GroupBys-报警的分组维度。
attribution_dimensionsArray of AttributionDimensions-报警归因维度。

AlarmPeriod

参数类型示例值描述

start_time

Integer

0

报警生效开始时间。
值为开始时间相对当天0点的秒时间戳，比如生效开始时间为当天2点，值为7200。

end_time

Integer

86399

报警生效结束时间。
值为结束时间相对当天0点的秒时间戳，比如生效结束时间为当天23:59:59，值为86399。

NotifyConfig

参数类型示例值描述

notify_types

Array of String

["mail"]

报警通知方式。

  • mail：邮箱
  • lark：飞书
  • wechat：企业微信
  • dingding：钉钉

notify_lark_webhooks

Array of String

[]

飞书通知webhooks列表。
当报警通知方式包含飞书时必填。

notify_groups

Array of Long

[ 291 ]

报警通知邮件组ID列表。
当报警通知方法包含邮件时必填。

notify_wechat_webhooks

Array of String

[]

企业微信通知webhook列表。
当报警通知方式包含企微时必填。

notify_dingding_webhooks

Array of String

[]

钉钉通知webhook列表。
当报警通知方式包含钉钉时必填。

PctAvoidSpike

参数类型示例值描述

pct

Integer

1

报警子窗口值。可选值为1~9。
当超过(含)X个子窗口的报警指标值超过设定的报警阈值时，才触发报警。

Measure

参数类型示例值描述

type

String

monomial

指标类型。

  • monomial：普通指标
  • polynomial：复合指标
raw_measure_listArray of RawMeasureList-报警指标列表。

formula

String

-

指标四则运算公式。
当指标类型为复合指标polynomial时选填。

name

String

PV

指标名。
当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。

FilterList

参数类型示例值描述

op

String

in

条件符号。

  • in：包含
  • not_in：不包含
  • Regex：正则匹配
  • not_regex：正则不匹配
filter_nameStringbrowser_brand筛选条件key。调用GetAlarmMetricRelatedMeta接口查看取值。
valuesArray of String["Chrome"]筛选条件值。调用GetAlarmMetricCandidate接口查看取值。

GroupBys

参数类型示例值描述
group_by_nameStringpid分组维度key。调用GetAlarmMetricRelatedMeta接口查看取值。
labelStringpid分组指标。

AttributionDimensions

参数类型示例值描述
group_by_nameStringpid归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。
labelStringpid归因维度。

RawMeasureList

参数类型示例值描述
measure_nameStringpv_uv.count简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。
filter_listArray of FilterList-筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。
event_nameString-自定义事件key。当指标为自定义事件指标时必填。

请求示例

POST https://open.volcengineapi.com/?Action=GetAlarmRuleList&Version=2022-10-12
{
    "common":{
        "aid":12345,
        "os":"webpro"
    },
    "category_list":[
        "pageview"
    ],
    "keyword":"test",
    "self":1,
    "page_num":1,
    "page_size":10
}

返回示例

{
    "err_detail":"",
    "data":{
        "alarm_param":{
            "id":1,
            "name":"test",
            "alarm_level":"warning",
            "desc":"",
            "category":"pageview",
            "interval_seconds":300,
            "strategy_op":"and",
            "strategy_list":[
                {
                    "alarm_window_size":180,
                    "measure":{
                        "type":"monomial",
                        "raw_measure_list":[
                            {
                                "measure_name":"pv_uv.count",
                                "event_name":"",
                                "filter_list":[
                                    {
                                        "filter_name":"browser_brand",
                                        "values":[
                                            "Chrome"
                                        ],
                                        "op":"in"
                                    }
                                ]
                            }
                        ],
                        "formula":"",
                        "name":"PV",
                        "unit":{
                            "unit_type":"",
                            "unit":""
                        }
                    },
                    "alarm_strategy_type":"threshold",
                    "daily_compare_count":5,
                    "threshold_cmp_op":"gt",
                    "alarm_threshold":10,
                    "group_bys":[
                        {
                            "label":"pid",
                            "group_by_name":"pid"
                        }
                    ],
                    "attribution_dimensions":[
                        {
                            "label":"pid",
                            "group_by_name":"pid"
                        }
                    ],
                    "filter_list":[
                        {
                            "filter_name":"pid",
                            "op":"in",
                            "values":[
                                "看板"
                            ]
                        }
                    ],
                    "alarm_user_threshold":1,
                    "alarm_sample_threshold":1
                }
            ],
            "alarm_period":{
                "start_time":0,
                "end_time":86399
            },
            "notify_config":{
                "notify_types":[
                    "mail"
                ],
                "notify_groups":[
                    291
                ],
                "notify_lark_webhooks":[

                ],
                "notify_wechat_webhooks":[

                ],
                "notify_dingding_webhooks":[

                ]
            },
            "is_avoid_spike":false,
            "is_close":0,
            "pct_avoid_spike":{
                "pct":1
            }
        },
        "created_by":"leeac",
        "updated_by":"leeac",
        "created_time":1666008398,
        "updated_time":1666008398,
        "next_trigger_time":1666008698,
        "last_execute_time":0,
        "ack_until_time":0
    },
    "error_msg":"",
    "error_no":0
}

错误码

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