ListSystemBotConfig - 查询系统托管 bot 配置--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListSystemBotConfig - 查询系统托管 bot 配置

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

查询指定域名对应的系统托管 bot 配置，包括 bot 名称、描述、动作和 ID 等信息。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
Host	String	是	abc.com	需要查询的域名。

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	--	托管 Bot 配置信息。

请求示例

POST /?Action=ListSystemBotConfig&Version=2023-12-25 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240603T080428Z
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

{
  "Host": "abc.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240527152327016000241079F3****",
    "Action": "ListSystemBotConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
            "BotType": "feed_fetcher",
            "Description": "订阅工具，一般为站点提供内容自动化订阅服务，对站点公开内容进行推广，利于提升站点的活跃度",
            "Action": "observe",
            "Enable": 1,
            "RuleTag": "J000000000001"
        },
        {
            "BotType": "http_library",
            "Description": "HTTP协议请求程序库(涵盖各类编程语言，如go, java, python等)",
            "Action": "observe",
            "Enable": 1,
            "RuleTag": "J000000000002"
        }
    ]
  }
}

错误码

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