UpdateSystemBotConfig - 更新系统托管 bot 配置--Web应用防火墙-火山引擎

文档中心

立即注册

导航

UpdateSystemBotConfig - 更新系统托管 bot 配置

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

通过 bot 名称更新指定域名下的托管 bot 配置，包括 bot 的执行动作或者启用状态。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
BotType	String	是	feed_fetcher	需要更新的 bot 名称。
Action	String	否	observe	Bot 的执行动作。 observe：观察 block：拦截
Enable	Integer	否	1	是否启用 bot。 0：不启用 1：启用
Host	String	是	example.com	对应域名信息。

返回参数

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

请求示例

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

{
  "BotType": "feed_fetcher",
  "Action": "observe",
  "Enable": 1,
  "Host": "example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024052716184419305808822736****",
    "Action": "UpdateSystemBotConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": null
}

错误码

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