文档首页/ Web应用防火墙 WAF/ API参考 (巴黎) / API说明/ 云模式/ 告警通知配置/ 更新告警通知配置
更新时间：2022-02-22 GMT+08:00
查看PDF
分享

更新告警通知配置

功能介绍

更新告警通知配置。

URI

  • URI格式

    PUT /v1/{project_id}/waf/config/alert/{alertconfig_id}

  • 参数说明
    表1 Path参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    用户操作的项目ID。

    alertconfig_id

    是

    String

    需要更新的告警通知配置ID。请参考查询告警通知配置查询告警通知配置ID。

请求消息

请求参数
表2 请求参数说明

名称

是否必选

参数类型

说明

enabled

是

Boolean

是否发送告警通知。

  • true：发送告警通知。
  • false：不发送告警通知。

topic_urn

是

String

发送到哪个告警通知群组。

说明：

选择的告警通知群组必须为有效的群组，即已经在SMN里完成了订阅信息配置的主题群组。

sendfreq

是

Integer

发送告警的最低时间限制，单位是“分钟”，最小取值为5，固定取值5、15、30、60。

times

是

Integer

固定时间内告警的次数，小于这个次数则不发送告警通知。取值大于等于1。

threat

是

List<String>

事件类型列表。

  • “all”代表全部。
  • “cc”代表CC攻击。
  • “cmdi”代表命令注入。
  • “custom”代表精准防护。
  • “illegal”代表非法请求。
  • “sqli”代表SQL注入。
  • “lfi”代表本地文件包含。
  • “robot”代表恶意爬虫。
  • “antitamper”代表网页防篡改。
  • “rfi”代表远程文件包含。
  • “vuln”代表其他类型攻击。
  • “xss”代表xss攻击。
  • “whiteblackip”代表IP黑白名单。
  • “webshell”代表网站木马。

locale

否

String

语言配置，只支持zh-cn简体中文、en-us美式英文，默认是en-us。

响应消息

响应参数
表3 响应参数说明

名称

参数类型

说明

id

String

告警配置的唯一标识。

enabled

Boolean

是否发送告警通知。

  • true：发送告警通知。
  • false：不发送告警通知。

topic_urn

String

自定义选择的告警通知群组，用户通过该群组设置的电话或者邮箱地址接收告警通知。

sendfreq

Integer

发送告警的最低时间限制，单位是“分钟”，最小取值为5，固定取值5、15、30、60。

times

Integer

固定时间内告警的次数，小于这个次数则不发送告警通知。取值大于等于1。

threat

List<String>

事件类型列表。

  • “all”代表全部。
  • “cc”代表CC攻击。
  • “cmdi”代表命令注入。
  • “custom”代表精准防护。
  • “illegal”代表非法请求。
  • “sqli”代表SQL注入。
  • “lfi”代表本地文件包含。
  • “robot”代表恶意爬虫。
  • “antiTamper”代表网页防篡改。
  • “rfi”代表远程文件包含。
  • “vuln”代表其他类型攻击。
  • “xss”代表xss攻击。
  • “whiteblackip”代表IP黑白名单。
  • “webshell”代表网站木马。

locale

String

语言配置，只支持zh-cn简体中文、en-us美式英文，默认是en-us。

示例

如下以更新告警通知配置为例。

  • 请求样例 
    {
    "enabled": true,
    "topic_urn": "urn:smn:eude:fca6f667ac5f4d9798d1641dfd38106b:wbtest",
    "sendfreq": 5,
    "times": 200,
    "threat": ["xss", "sqli", "cmdi"]
}
  • 响应样例 
    {
    "id": "37b4bbe8a562453aa0163a96e6b71dd6",
    "enabled": true,
    "topic_urn": "urn:smn:eude:fca6f667ac5f4d9798d1641dfd38106b:wbtest",
    "sendfreq": 5,
    "times": 200,
    "threat": ["xss", "sqli", "cmdi"],
    "locale": "en-us"
}

状态码

表4描述的是API返回的正常状态码。
表4 状态码

状态码

编码

状态说明

200

OK

客户端请求已处理成功。

异常状态码，请参见状态码。

父主题： 告警通知配置