更新错误新增报警规则。

请求说明

客户端监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UpdateWebProNewErrorAlertRule&Version=2022-10-12

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateWebProNewErrorAlertRule	接口名称。当前 API 的名称为 UpdateWebProNewErrorAlertRule。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
alert_param	Object of AlertParam	否	-	报警参数集合。
common	Object of CommonParams	是	-	通用参数。

AlertParam

参数	类型	是否必选	示例值	描述
id	Long	否	1	报警任务ID。
name	String	否	test	报警任务名称。
chats	Array of String	否	[1234]	报警通知群。
methods	Array of String	否	lark_webhook	配置报警通知方式。 mail：邮箱 lark_webhook：飞书 wechat_webhook：企业微信 dingding_webhook：钉钉 webhook：报警回调
is_close	Boolean	否	0	是否开启报警。 0：开启 1：关闭
receivers	Array of String	否	[]	接收人。当报警通知方式为lark时必填。
alert_level	String	否	warning	报警级别。 warning：提示 fatal：严重
mail_groups	Array of String	否	[123]	邮件通知组。
lark_at_conf	Object of AtConf	否	Jack	飞书需要at的人。
callback_urls	Array of String	否	[]	报警回调webhook。
lark_webhooks	Array of String	否	[]	飞书webhook。
alert_language	String	否	zh	报警语言。 en：海外 zh：国内
alert_strategy	Object of AlertStrategy	否	all	报警策略。多策略之间的关系只能是或。 latest：最新版本 specify：指定版本 all：全部版本
wechat_at_conf	Object of AtConf	否	Rose	企业微信需要at的人。
dingding_at_conf	Object of AtConf	否	Carl	钉钉需要at的人。
we_chat_webhooks	Array of String	否	[]	企业微信webhook。
dingding_webhooks	Array of String	否	[]	钉钉webhook。

CommonParams

参数	类型	是否必选	示例值	描述
aid	Long	是	12345	应用ID。
site_type	String	是	web	站点类型。
env	String	是	online	环境，填""时为全部。
os	String	否	webpro	服务类型，可选值为webpro，app，minipro。
user	String	否	test_user	用户名。

AtConf

参数	类型	是否必选	示例值	描述
id_type	String	否	userid	类型。
id_values	Array of String	否	[]	类型对应的值。

AlertStrategy

参数	类型	是否必选	示例值	描述
evType	String	否	js_error	枚举类型。 js_error：JS错误 http：请求错误 resource_error：静态资源错误
releases	Array of String	否	2.0.0	如果关注的是版本的新增错误，则需要传关注的版本列表。
disappear_time	Integer	否	30	多少天未出现认为是新错误。
user_threshold	Integer	否	100	用户数阈值。
filter_condition	Object of FilterConditions	否	-	筛选条件。
sample_threshold	Integer	否	100	样本数量阈值。
isReleaseNewError	Boolean	否	true	是否关注的是版本新增错误。 true：是 false：否

FilterConditions

参数	类型	是否必选	示例值	描述
type	String	否	and	筛选条件key。
sub_conditions	Array of SubCondition	否	[]	筛选条件值。

SubCondition

参数	类型	是否必选	示例值	描述
op	String	否	in	条件符号。 in：包含 not_in：不包含 Regex：正则匹配 not_regex：正则不匹配
value	String	否	-	筛选值的值，表示等值。
values	Array of String	否	-	筛选值的值，表示范围。
groupKey	String	否	-	报警分组维度。
dimension	String	否	-	报警归因维度。

请求示例

POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UpdateWebProNewErrorAlertRule&Version=2022-10-12​
{​
  "common": {​
    "aid": 1,​
    "os": "webpro"​
  },​
  "alert_param": {​
    "name": "newRule",​
    "is_close": false,​
    "methods": [​
      "lark_webhook"​
    ],​
    "alert_language": "zh",​
    "alert_level": "warning",​
    "note": "",​
    "id": 1,​
    "lark_webhooks": [​
      "your webhook"​
    ],​
    "lark_at_conf": {​
      "id_type": "userid",​
      "id_values": []​
    },​
    "alert_strategy": {​
      "evType": "js_error",​
      "isReleaseNewError": true,​
      "user_threshold": 200,​
      "sample_threshold": 100,​
      "filter_condition": {​
        "type": "and",​
        "sub_conditions": []​
      }​
    }​
  }​
}

返回参数

参数	类型	示例值	描述
error_no	Integer	0	错误码。成功为0。
error_msg	String	""	错误信息。成功为""。

返回示例

{​
  "err_detail": "",​
  "data": null,​
  "error_msg": "",​
  "error_no": 0​
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

应用性能监控全链路版