CreateCustomBotConfig - 创建自定义 bot 规则--Web应用防火墙-火山引擎

文档中心

立即注册

导航

CreateCustomBotConfig - 创建自定义 bot 规则

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

创建对应防护域名的自定义 Bot 规则。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必填	示例值	描述
Action	String	是	CreateCustomBotConfig	要执行的操作，取值：CreateCustomBotConfig。
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	需要创建规则的防护网站域名。
Accurate	Object	是	--	高级配置详情。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Id	Integer	55676	规则 ID 的后五位。

请求示例

POST /?Action=CreateCustomBotConfig&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240603T080321Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240603/cn-beijing/waf/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024052716580210820122702213****",
    "Action": "CreateCustomBotConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Id": 55676
  }
}

错误码

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