UpdateCustomBotConfig - 更新自定义 bot 规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

UpdateCustomBotConfig - 更新自定义 bot 规则

最近更新时间：2024.10.12 12:01:30首次发布时间：2024.10.12 12:01:30

根据规则 ID 和关联域名等信息，更新自定义 bot 规则。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=UpdateCustomBotConfig&Version=2023-12-25

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateCustomBotConfig	要执行的操作，取值：UpdateCustomBotConfig。
Version	String	是	2023-12-25	API的版本，取值：2023-12-25。

Body

参数	类型	是否必填	示例值	描述
BotType	String	是	Bot1	Bot 名称，支持英文、汉字和数字，不支持特殊字符。长度限制在 20 个字符内。
Description	String	否	该机器人用于XX，具备XX的功能。	Bot 相关描述。
Action	String	是	observe	执行动作。 observe：观察 block：拦截
Enable	Integer	是	1	是否启用该规则。 0：不启用 1：启用
Host	String	是	example.volcwaf001.com	需要更新规则的防护网站域名。
Id	Integer	是	923	规则 ID，获取方式可参考ListCustomBotConfig - 查询自定义规则详情。
Accurate	Object	是		高级配置。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateCustomBotConfig&Version=2023-12-25&BotType=Bot1 HTTP/1.1
Host: volcengineapi-boe-stable.byted.org
Content-Type: application/json; charset=UTF-8
X-Date: 20240527T090429Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240527/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Description": "该机器人用于XX，具备XX的功能。",
  "Action": "observe",
  "Enable": 1,
  "Advanced": 1,
  "Host": "example.volcwaf001.com",
  "Id": 923,
  "Accurate": {
    "Logic": 1,
    "AccurateRules": [
      {
        "HttpObj": "request.schema",
        "ObjType": 0,
        "Opretar": 343,
        "Property": 0,
        "ValueString": "Get"
      }
    ]
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240527170441036114203192C28A3F",
    "Action": "UpdateCustomBotConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": null
}

错误码

您可访问公共错误码，获取更多错误码信息。