更新时间:2023.04.11 16:29:02
调用GetAlarmAttribution接口获取归因信息。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 |
| 请求名称。 |
Version | String | 是 |
| 请求版本。 |
ServiceName : apmplus_openapi Region : cn-beijing X-App-Ids : xxx Content-Type : application/json
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
alarm_param | array | 是 | - | 报警任务参数列表。 |
strategy_id | int | 是 |
| 报警策略下标。表示归因的策略在alarm_param.strategy_list中的下标值。 |
attribution_time | int64 | 是 |
| 报警归因终止时间。归因时间范围为[alarm_attribution_time-alarm_window_size*60, alarm_attribution_time]。 |
group_by_value | string | 是 |
| 归因维度key。调用 |
common | object of common | 是 | - | 通用参数。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
id | int | 是 |
| 报警任务ID。 |
name | string | 是 |
| 报警任务名。 |
alarm_level | string | 是 |
| 报警级别。
|
desc | string | 是 | - | 报警说明。 |
category | string | 是 |
| 报警类别key。调用由
|
interval_seconds | int32 | 是 |
| 报警任务执行间隔。
|
strategy_op | string | 是 |
| 报警多策略关系。
|
strategy_list | object of strategy_list | 是 | - | 报警策略列表。 |
alarm_period | object of alarm_period | 是 | - | 报警生效时间。时间范围外的报警不通知。 |
notify_config | object of notify_config | 是 | - | 报警任务通知配置。 |
is_avoid_spike | bool | 是 |
| 报警优化,是否过滤尖刺报警。 |
is_close | int8 |
| 是否关闭报警。
| |
pct_avoid_spike | object of pct_avoid_spike | 是 | - | pct报警参数,当开启pct报警屏蔽时必填。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
alarm_window_size | int32 | 是 |
| 报警任务查询时间窗口,表示最近X分钟。单位为分钟。 |
measure | object of measure | 是 | - | 指标集合。 |
alarm_strategy_type | string | 是 |
| 报警策略类型。
|
daily_compare_count | int32 | 否 |
| 上一周期与当前周期的时间间隔。 |
threshold_cmp_op | string | 是 |
| 策略符号。
|
alarm_threshold | int32 | 是 |
| 报警阈值。 |
group_bys | object of group_bys | 是 | - | 报警分组维度。 |
attribution_dimensions | object of attribution_dimensions | 是 | - | 报警归因维度。 |
filter_list | object of filter_list | 是 | - | 报警策略筛选条件。 |
alarm_user_threshold | int32 | 是 |
| 用户数阈值。 |
alarm_sample_threshold | int32 | 是 |
| 样本量阈值。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
type | string | 是 |
| 指标类型。
|
raw_measure_list | array | 是 | - | 指标集合的列表。 |
formula | string | 是 | - | 指标四则运算公式。 |
name | string | 是 |
| 指标名。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
measure_name | string | 是 |
| 简单指标key。调用 |
event_name | string | 是 | - | 自定义事件key。当指标为自定义事件指标时必填。 |
filter_list | object of filter_list | 是 | - | 筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
filter_name | string | 是 |
| 筛选条件key。调用 |
op | string | 是 |
| 条件符号。
|
values | array | 是 |
| 筛选条件值。调用 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
label | string | 是 |
| 分组指标。 |
group_by_name | string | 是 |
| 分组维度key。调用 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
label | string | 是 |
| 归因指标。 |
group_by_name | string | 是 |
| 归因维度key。调用 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
start_time | int32 | 是 |
| 报警生效开始时间。 |
end_time | int32 | 是 |
| 报警生效结束时间。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
notify_types | array | 是 |
| 报警任务通知方式。
|
notify_groups | array | 是 |
| 报警通知邮件组ID列表。 |
notify_lark_webhooks | array | 是 |
| 飞书通知webhooks列表。 |
notify_wechat_webhooks | array | 是 |
| 企微通知webhooks列表。 |
notify_dingding_webhooks | array | 是 |
| 钉钉通知webhooks列表。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
pct | int8 | 是 |
| 报警子窗口值。可选值为1~9。 |
参数 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
aid | int64 | 是 |
| 应用ID。 |
os | string | 是 |
| 服务类型。 |
参数 | 类型 | 示例值 | 说明 |
---|---|---|---|
err_detail | string | - | 错误详情。 |
data | array |
| 返回内容。 |
error_msg | string | - | 错误信息。 |
error_no | int |
| 错误码。0为成功。 |
参数 | 类型 | 示例值 | 说明 |
---|---|---|---|
alarm_category | string |
| 报警任务类型。 |
attribution_dimension | string |
| 归因维度key。 |
attribution_dimension_label | string |
| 归因任务指标。 |
detail_list | array of detail_list | - | 归因结果。 |
参数 | 类型 | 示例值 | 说明 |
---|---|---|---|
name | object |
| JS监控列表。 |
link | string | - | 报警时间,为source[i][0]值的含义。 |
POST https://open.volcengineapi.com/?Action=GetAlarmAttribution&Version=2022-10-12 { "common":{ "aid":12345, "os":"webpro" }, "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 } }, "strategy_id":0, "attribution_time":1666012500, "group_by_value":"Chrome Webview" }
{ "err_detail":"", "data":[ { "alarm_category":"performance", "attribution_dimension":"pid", "attribution_dimension_label":"TOP pid", "detail_list":[ { "name":"JS 监控列表", "link":"" } ] }, { "alarm_category":"performance", "attribution_dimension":"pid", "attribution_dimension_label":"TOP 同上周期比增长最快 pid", "detail_list":[ { "name":"JS 监控列表", "link":"" } ] } ], "error_msg":"", "error_no":0 }