获取全部报警历史。
ServiceName: apmplus_openapi Region: cn-beijing X-App-Ids: xxx Content-Type: application/json
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetAlarmAllHistory | 接口名称。当前 API 的名称为 GetAlarmAllHistory。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| common | Object of Common | 否 | - | 通用参数。 |
| time_filter | Object of TimeFilter | 否 | - | 时间区间。 |
| category_list | Array of String | 否 | pageview | 报警任务类别。不填时返回全部类别报警历史。调用GetAlarmMeta接口查看取值。 |
| name_list | Array of String | 否 | 111111 | 报警任务名称列表。不填时返回全部名称报警历史。调用GetAlarmRuleList接口查看取值。 |
level_list | Array of String | 否 |
| 报警级别列表。不填时返回全部类型报警。
|
| page_size | Integer | 否 | 10 | 报警历史列表返回项数。 |
| page_num | Integer | 否 | 1 | 报警历史列表页数。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| aid | Long | 否 | 12345 | 应用ID。 |
| os | String | 否 | webpro | 服务类型。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| start_time | Integer | 否 | 1665849600 | 起始时间。 |
| granularity | Integer | 否 | 60 | 聚合时间粒度。单位s。 |
| end_time | Integer | 否 | 1666011403 | 终止时间。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| data | Object of Data | - | 返回内容。 |
| error_msg | String | "" | 错误信息。成功为""。 |
| error_no | Integer | 0 | 错误码。成功为0。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| alarm_all_histories | Array of AlarmAllHistories | - | 报警趋势。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id | Long | 160570 | 报警历史ID。 |
| alarm_param | Object of AlarmParam | - | 报警参数。 |
| alarm_time | Long | 1666011480 | 报警发生时间。 |
| alarm_result | Object of AlarmResult | - | 报警结果。 |
ack_status | Integer |
| 报警时的ack状态。
|
| ack_until_time | Long | 1659611486 | ACK到期时间。现在的状态，用于在报警统计时进行ack操作的回显。 |
| operator | String | bytedance-apm | 报警任务的最近更新人。 |
| detail_link | String | /apmplus/webpro/data_search?aid=12345&end_time=1666011480&ev_type=view&start_time=1666000680 | 报警详情链接。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id | Long | 302 | 报警任务ID。 |
| name | String | test | 报警任务名称。 |
| desc | String | - | 报警说明。 |
is_close | Integer |
| 是否关闭报警。
|
| category | String | performance | 报警类型。 |
category_label | String |
| 报警类型筛选。 |
alarm_level | String |
| 报警级别。
|
| strategy_list | Array of StrategyList | - | 报警策略列表。 |
strategy_op | String |
| 多策略关系。
|
interval_seconds | Integer |
| 报警任务执行间隔。
|
| alarm_period | Object of AlarmPeriod | - | 报警生效时间。时间范围外的报警不通知。 |
| notify_config | Object of NotifyConfig | - | 通知配置。 |
| is_avoid_spike | Boolean | false | 是否屏蔽尖刺报警。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| is_alarm | Boolean | true | 是否报警。 |
| strategy_result_list | Array of StrategyResultList | - | 分策略报警结果。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| id | String | 123-456 | 报警ID。 |
| measure | Object of Measure | - | 当前策略的指标，包括普通指标和复合指标。 |
| filter_list | Array of FilterList | [] | 报警策略筛选条件。 |
alarm_strategy_type | String |
| 报警策略类型。
|
daily_compare_count | Integer |
| 上一周期与当前周期的时间间隔。 |
| alarm_threshold | Double | 0 | 报警阈值。 |
threshold_cmp_op | String |
| 策略符号。
|
| alarm_user_threshold | Double | 0 | 用户数阈值。 |
| alarm_sample_threshold | Double | 0 | 样本量阈值。 |
| alarm_window_size | Long | 180 | 报警任务查询时间窗口，表示最近X分钟。单位为分钟。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
start_time | Integer |
| 报警生效开始时间。 |
end_time | Integer |
| 报警生效结束时间。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
notify_types | Array of String |
| 报警任务通知方式。
|
notify_groups | Array of Long |
| 报警通知邮件组ID列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| is_alarm | Boolean | true | 是否满足策略条件。 |
| title | String | 慢页面次数阈值报警 | 查询结果的标题。 |
| is_attributable | Boolean | false | 是否归因。 |
| group_result_list | Array of GroupResultList | - | 分组报警结果。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
type | String |
| 指标类型。
|
| raw_measure_list | Array of RawMeasureList | - | 报警指标列表。 |
formula | String |
| 指标四则运算公式。 |
name | String |
| 指标名。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| op | String | - | 筛选条件和筛选值的关系。 |
| filter_name | String | - | 筛选维度。 |
| values | Array of String | - | 筛选值。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| is_alarm | Boolean | true | 是否报警。 |
| group_value | String | - | 分组值，比如国家分组的中国，如果不是分组报警则不返回。 |
| alarm_tag_list | Array of AlarmTagList | - | 报警列表标签。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| measure_name | String | slow_load_count | 简单指标key。 |
| filter_list | Array of FilterList | [] | 筛选条件。当指标类型为复合指标时单个简单指标携带条件时选填。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| label | String | 当前值 | 指标。 |
| value | Double | 1174 | 当前指标的取值。 |
| format_value | String | 1174 | 格式化后的值，暂时只有时间窗口有特殊处理，加时间单位。 |
POST https://open.volcengineapi.com/?Action=GetAlarmAllHistory&Version=2022-10-12 { "common":{ "aid":312541, "os":"webpro" }, "time_filter":{ "start_time":1665849600, "end_time":1666011403, "granularity":3600 }, "page_size":10, "page_num":1, "category_list":[ "pageview" ], "name_list":[ "111111111" ], "level_list":[ "warning" ] }
{ "err_detail":"", "data":{ "alarm_all_histories":[ { "id":160570, "alarm_param":{ "id":302, "name":"jiyi-test", "desc":"", "is_close":0, "category":"performance", "category_label":"", "alarm_level":"warning", "strategy_list":[ { "id":"123-456", "measure":{ "type":"monomial", "raw_measure_list":[ { "measure_name":"slow_load_count", "filter_list":[ ], "event_name":"" } ], "formula":"", "name":"慢页面次数" }, "filter_list":[ ], "alarm_strategy_type":"threshold", "daily_compare_count":5, "alarm_threshold":0, "threshold_cmp_op":"gte", "alarm_user_threshold":0, "alarm_sample_threshold":0, "alarm_window_size":180, "sample_metric":{ "type":"monomial", "raw_measure_list":[ { "measure_name":"browser_perf.count", "filter_list":[ ] } ], "formula":"", "name":"count" }, "user_metric":{ "type":"monomial", "raw_measure_list":[ { "measure_name":"browser_perf.user", "filter_list":[ ] } ], "formula":"", "name":"user" } } ], "strategy_op":"and", "interval_seconds":300, "alarm_period":{ "start_time":0, "end_time":86399 }, "notify_config":{ "notify_types":[ "mail" ], "notify_groups":[ 287 ] }, "is_avoid_spike":false, "aid":123456, "os":"webpro" }, "alarm_time":1666011480, "alarm_content":"\n最近180分钟慢页面次数阈值>=0 \n 当前值:1174 阈值:0 样本量:10745 用户数:458 时间窗口:180分钟\n", "alarm_result":{ "is_alarm":true, "strategy_result_list":[ { "is_alarm":true, "title":"慢页面次数阈值报警", "is_attributable":false, "group_result_list":[ { "is_alarm":true, "group_value":"", "alarm_tag_list":[ { "label":"当前值", "value":1174, "format_value":"1174" }, { "label":"阈值", "value":0, "format_value":"0" }, { "label":"样本量", "value":10745, "format_value":"10745" }, { "label":"用户数", "value":458, "format_value":"458" }, { "label":"时间窗口", "value":180, "format_value":"3 分钟" } ], "alarm_value":{ "current_value":{ "label":"当前值", "value":1174, "format_value":"" }, "alarm_threshold":{ "label":"阈值", "value":0, "format_value":"0" }, "sample_count":{ "label":"样本量", "value":10745, "format_value":"10745" }, "user_count":{ "label":"用户数", "value":458, "format_value":"458" }, "window_size":{ "label":"时间窗口", "value":180, "format_value":"3 分钟" } }, "is_spike":false } ] } ] }, "ack_status":1, "ack_until_time":1659611486, "operator":"bytedance-apm", "detail_link":"/apmplus/webpro/data_search?aid=123456&end_time=1666011480&ev_type=view&start_time=1666000680" } ], "count":1265 }, "error_msg":"", "error_no":0 }
本接口无特有的错误码。更多信息请参见错误码。