应用性能监控全链路版
应用性能监控全链路版
文档指南
请输入
- 文档首页
应用性能监控全链路版API 参考API 接口 - WebPro 端报警GetAlarmTaskDetail
复制全文
下载 pdfGetAlarmTaskDetail
文档反馈
问问助手获取指定报警任务详情。
请求说明
- 请求方式：POST
- 请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmTaskDetail&Version=2022-10-12
请求参数
Common
请求示例
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=GetAlarmTaskDetail&Version=2022-10-12
{
"common":{
"aid":312541,
"os":"webpro"
},
"id":302
}
返回参数
Data
AlarmParam
StrategyList
参数 | 类型 | 示例值 | 描述 |
measure | - | 指标集合。 | |
filter_list | - | 报警策略筛选维度。 | |
alarm_strategy_type | String | threshold | 报警策略类型。
|
daily_compare_count | Integer | 5 | 上一周期与当前周期的时间间隔。 当报警策略为比值报警时必填，分钟单位，比如比前1天值为1440。 |
alarm_threshold | Double | 10 | 报警阈值。 |
threshold_cmp_op | String | gt | 策略符号。
|
alarm_user_threshold | Double | 1 | 用户数阈值。 |
alarm_sample_threshold | Double | 1 | 样本量阈值。 |
alarm_window_size | Long | 180 | 报警任务查询时间窗口，表示最近X分钟。单位为分钟。 |
group_bys | - | 报警的分组维度。 | |
attribution_dimensions | - | 报警的归因维度。 |
AlarmPeriod
NotifyConfig
参数 | 类型 | 示例值 | 描述 |
notify_types | Array of String | ["mail"] | 报警任务通知方式。
|
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
Measure
参数 | 类型 | 示例值 | 描述 |
type | String | monomial | 指标类型。
|
raw_measure_list | - | 报警指标列表。 | |
formula | String | - | 指标四则运算公式。 当指标类型为复合指标polynomial时选填。 |
name | String | PV | 指标名。 当指标为普通指标时为指标名，指标为复合指标时为自定义指标名。 |
FilterList
GroupBys
参数 | 类型 | 示例值 | 描述 |
group_by_name | String | pid | 分组维度key。调用GetAlarmMetricRelatedMeta接口查看取值。 |
label | String | pid | 分组指标。 |
AttributionDimensions
参数 | 类型 | 示例值 | 描述 |
group_by_name | String | pid | 归因维度key。调用GetAlarmMetricRelatedMeta接口查看取值。 |
label | String | pid | 归因指标。 |
RawMeasureList
参数 | 类型 | 示例值 | 描述 |
measure_name | String | pv_uv.count | 简单指标key。调用GetAlarmMeta和GetAlarmEventMetaMetric接口查看取值。 |
filter_list | - | 筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。 | |
event_name | String | - | 自定义事件key。当指标为自定义事件指标时必填。 |
返回示例
{
"err_detail":"",
"data":{
"alarm_rule_list":[
{
"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":[
"dashboard"
]
}
],
"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":1665409567,
"updated_time":1665409567,
"next_trigger_time":1665409867,
"last_execute_time":0,
"ack_until_time":0,
"num_of_alarm_in_last_one_month":0
}
],
"count":1
},
"error_msg":"",
"error_no":0
}
错误码
最近更新时间：2026.08.28 16:25:32
这个页面对您有帮助吗？
有用
有用
无用
无用