ListCustomBotConfig - 查询自定义 bot 规则详情--Web应用防火墙-火山引擎

文档中心

立即注册

导航

ListCustomBotConfig - 查询自定义 bot 规则详情

最近更新时间：2025.03.31 16:27:40首次发布时间：2023.11.10 18:24:48

调用 ListCustomBotConfig 接口可查询指定域名下的自定义 bot 规则。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必填	示例值	描述
Page	Integer	否	1	页数。
PageSize	Integer	否	10	每个页面的条目数量上限。
Host	String	是	example.volcwaf001.com	域名信息。

返回参数

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

参数	类型	示例值	描述
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	每页包含的条目数量上限。
TotalCount	Integer	15	符合查询条件的条目总数。
Count	Integer	5	当前页面显示的条目数量。
Page	Integer	1	当前页码。
Data	Array of Object	--	自定义 bot 详情。

请求示例

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

{
    "Page": 1,
    "PageSize": 10,
    "Host": "example.volcwaf001.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250328205238210238087175BF00BE",
    "Action": "ListCustomBotConfig",
    "Version": "2023-12-25",
    "Service": "waf",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 15,
    "Count": 5,
    "Page": 1,
    "Data": [
      {
        "BotType": "Bot1",
        "Description": "该机器人用于XX，具备XX的功能。",
        "Action": "observe",
        "Enable": 1,
        "UpdateTime": "2023-10-10T14:59:29+08:00",
        "Advanced": 1,
        "RuleTag": "K000000041067",
        "Accurate": [
          {
            "Logic": 1,
            "AccurateRules": [
              {
                "ValueString": "http",
                "Opretar": 2,
                "ObjType": 0,
                "HttpObj": "request.schema",
                "Property": 0
              }
            ]
          }
        ],
        "Id": "41067"
      }
    ]
  }
}

错误码

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