You need to enable JavaScript to run this app.
导航
应用性能监控全链路版
  • 文档首页
    • /应用性能监控全链路版/OpenAPI参考/WebPro端/错误新增报警/GetWebProNewErrorAlertHistory
GetWebProNewErrorAlertHistory
最近更新时间：2024.07.11 10:20:21首次发布时间：2024.07.11 10:20:21
我的收藏

获取错误新增报警触发历史纪录。

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
idLong否1报警ID。
page_sizeInteger否10分页查询参数，用于设置每页行数。默认值：10。
page_numInteger否1分页查询参数，用于设置当前页码。默认值：1。
time_filterObject of TimeFilter否-时间区间。
commonObject of CommonParams否-通用参数。

TimeFilter

参数类型是否必选示例值描述
start_timeInteger是1665485413起始时间，单位s。
end_timeInteger是1665744613终止时间，单位s。
granularityInteger否3600聚合时间粒度，单位s。

CommonParams

参数类型是否必选示例值描述
aidLong是12345应用ID。
site_typeString是web站点类型。
envString是online环境，填""时为全部。
osString否webpro服务类型，可选值为webpro，app，minipro。
userString否test_user用户名。

返回参数

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

AlertHistoryList

参数类型示例值描述
countInteger10报警触发的历史记录数。
Alert_historiesArray of AlertHistory-报警历史详情。

AlertHistory

参数类型示例值描述
creatorStringleeac报警创建人。
alert_timeInteger1720605827报警发生时间。
alert_paramObject of AlertParam-报警参数。
detail_linkString-报警详情链接。
alarm_contentString-报警内容。

AlertParam

参数类型示例值描述
idLong1报警任务ID。
nameStringtest报警任务名称。
chatsArray of String[1234]报警通知群。

methods

Array of String

lark_webhook

配置报警通知方式。

  • mail：邮箱
  • lark_webhook：飞书
  • wechat_webhook：企业微信
  • dingding_webhook：钉钉
  • webhook：报警回调

is_close

Boolean

0

是否开启报警。

  • 0：开启
  • 1：关闭
receiversArray of String[]接收人。当报警通知方式为lark时必填。

alert_level

String

warning

报警级别。

  • warning：提示
  • fatal：严重
mail_groupsArray of String[123]邮件通知组。
lark_at_confObject of AtConfJack飞书需要at的人。
callback_urlsArray of String[]报警回调webhook。
lark_webhooksArray of String[]飞书webhook。

alert_language

String

zh

报警语言。

  • en：海外
  • zh：国内

alert_strategy

Object of AlertStrategy

all

报警策略。多策略之间的关系只能是或。

  • latest：最新版本
  • specify：指定版本
  • all：全部版本
wechat_at_confObject of AtConfRose企业微信需要at的人。
dingding_at_confObject of AtConfCarl钉钉需要at的人。
we_chat_webhooksArray of String[]企业微信webhook。
dingding_webhooksArray of String[]钉钉webhook。

AtConf

参数类型示例值描述
id_typeStringuserid类型。
id_valuesArray of String[]类型对应的值。

AlertStrategy

参数类型示例值描述

evType

String

js_error

枚举类型。

  • js_error：JS错误
  • http：请求错误
  • resource_error：静态资源错误
releasesArray of String2.0.0如果关注的是版本的新增错误，则需要传关注的版本列表。
disappear_timeInteger30多少天未出现认为是新错误。
user_thresholdInteger100用户数阈值。
filter_conditionObject of FilterConditions-筛选条件。
sample_thresholdInteger100样本数量阈值。

isReleaseNewError

Boolean

true

是否关注的是版本新增错误。

  • true：是
  • false：否

FilterConditions

参数类型示例值描述
typeStringand筛选条件key。
sub_conditionsArray of SubCondition[]筛选条件值。

SubCondition

参数类型示例值描述

op

String

in

条件符号。

  • in：包含
  • not_in：不包含
  • Regex：正则匹配
  • not_regex：正则不匹配
valueString-筛选值的值，表示等值。
valuesArray of String-筛选值的值，表示范围。
groupKeyString-报警分组维度。
dimensionString-报警归因维度。

请求示例

POST https://open.volcengineapi.com/?Action=GetWebProNewErrorAlertHistory&Version=2022-10-12
{
  "common": {
    "aid": 1,
    "os": "webpro"
  },
  "time_filter": {
    "start_time": 1719936000,
    "end_time": 1720072587
  },
  "id": 1,
  "page_size": 10,
  "page_num": 1
}

返回示例

{
  "err_detail": "",
  "data": {
    "Alert_histories": [],
    "count": 0
  },
  "error_msg": "",
  "error_no": 0
}

错误码

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