You need to enable JavaScript to run this app.
导航
CreateWebProNewErrorAlertRule
最近更新时间:2024.07.11 10:20:21首次发布时间:2024.07.11 10:20:21

创建错误新增报警规则。

请求说明

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

请求参数

Query

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

Body

参数类型是否必选示例值描述
alert_paramObject of AlertParam-报警参数集合。
commonObject of CommonParams-通用参数。

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。

CommonParams

参数类型是否必选示例值描述
aidLong12345应用ID。
site_typeStringweb站点类型。
envStringonline环境,填""时为全部。
osStringwebpro服务类型,可选值为webproappminipro
userStringtest_user用户名。

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-报警归因维度。

返回参数

参数类型示例值描述
dataObject of AddAlertResponseData-返回内容。
errmsgString""错误信息。成功为""
errnoInteger0错误码。成功为0。

AddAlertResponseData

参数类型示例值描述
idLong123****456错误新增报警任务ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreateWebProNewErrorAlertRule&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": "",
    "lark_webhooks": [
      "your webhook"
    ],
    "lark_at_conf": {
      "id_type": "userid",
      "id_values": []
    },
    "alert_strategy": {
      "evType": "js_error",
      "isReleaseNewError": true,
      "user_threshold": 100,
      "sample_threshold": 100,
      "filter_condition": {
        "type": "and",
        "sub_conditions": []
      }
    }
  }
}

返回示例

{
  "err_detail": "",
  "data": {
    "id": 1
  },
  "error_msg": "",
  "error_no": 0
}

错误码

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