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

文档中心

立即注册

导航

ListCustomBotConfig-查询自定义规则详情

最近更新时间：2024.03.01 16:47:38首次发布时间：2023.11.10 18:24:48

查询自定义 Bot 规则。

请求说明

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

请求参数

无

返回参数

参数	类型	示例值	描述
PageInfo	PageInfo object	-	页面信息。
Result	Array of Result objects	-	规则列表信息。

PageInfo

参数	类型	示例值	描述
TotalCount	Integer	`15`	查询到的符合条件的条目总数。
PageSize	Integer	`20`	单个页面显示的条目数量上限。
CurrentPage	Integer	`1`	当前页面的页码。
Count	Integer	`10`	当前页面显示的条目数量。

Result

参数	类型	示例值	描述
Id	String	`41067`	规则 ID 的后五位。
BotType	String	`Bot1`	Bot 名称，支持英文、汉字和数字，不支持特殊字符。长度限制在 20 个字符内。
Description	String	`该机器人用于XX，具备XX的功能。`	Bot 相关描述。
Action	String	`observe`	执行动作。 observe：观察 block：拦截
Enable	Integer	`1`	是否启用该规则。 0：不启用 1：启用
UpdateTime	String	`2023-10-10T14:59:29+08:00`	规则更新时间。
Advanced	Integer	`1`	是否启用高级配置。 0：不启用。 1：启用。
Accurate	Accurate object	-	高级配置详情。
RuleTag	String	`K000000041067`	规则 ID。

Accurate

参数	类型	是否必填	示例值	描述
AccurateRules	Array of AccurateRules objects	是		高级条件详情。
Logic	Integer	是	`1`	规则间的运算关系。 1：与 2：或

参数

类型

是否必填

示例值

描述

AccurateRules

Array of AccurateRules objects

是

高级条件详情。

Logic

Integer

是

1

规则间的运算关系。

1：与
2：或

AccurateRules

参数	类型	是否必填	示例值	描述
HttpObj	String	是	`request.method`	自定义对象，与`ObjType`存在映射关系。请求协议：`request.schema` 请求 uri：`request.uri` 请求方法：`request.method` 请求路径：`request.path` 请求参数：`request.queryargs` 请求头：`request.header` 请求 User-Agent：`request.header.ua` 请求 refer：`request.header.refer` 请求 Cookies：`request.header.cookies` 请求体长度：`request.header.content-length` 请求体格式：`request.header.content-type` X-forwarded-for：`request.header.x-forwarded-for` 客户端 IP：`request.header.clientip` 自定义 Args：`request.queryargs.自定义参数名称`。例如`request.queryargs.abc`。自定义 header：`request.header.自定义Header 名称`。例如`request.header.abc`。自定义 cookie：`request.cookie.自定义 cookie 名称`。例如`request.cookie.abc`。
ObjType	Integer	是	`0`	匹配字段。 0：请求协议 1：请求 uri 2：请求方法 3：请求路径 4：请求参数 5：请求头 6：请求 User-Agent 7：请求 refer 8：请求 Cookies 9：请求体长度 10：请求体格式 11：X-forwarded-for 12：客户端 IP 13：自定义 Args 14：自定义 header 15：自定义 cookie
Opretar	Integer	是	`0`	逻辑运算符。 0：大于 1：大于等于 2：等于 3：小于 4：小于等于 5：不等于 6：包含子串 7：不包含子串 8：包含前缀 9：不包含前缀 10：包含后缀 11：不包含后缀 12：包含所有匹配集合 13：不包含所有匹配集合 14：属于匹配集合 15：不属于匹配集合 16：正则 17：判断为 IP 18：判断为 IPv4 19：判断为 IPv6 20：判断为私网 IP 21：判断为公网 IP
Property	Integer	是	`0`	0：匹配对应值。
ValueString	string	是	`123`	匹配内容。逻辑关系判断为 IP、 IPv4、 IPv6、私网 IP 或公网 IP 时不需要填写。

请求示例

POST https://open.volcengineapi.com/?Action=ListCustomBotConfig&Version=2020-12-09
X-Date: 20230711T035055Z
Authorization: HMAC-SHA256 Credential=AKLTNGU0OGEyMT***/20230711/cn-beijing/waf/request, SignedHeaders=content-type;x-content-sha256;x-date, Signature=da4fac562d00f41ad8***

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231019203051F855FF4C01EE580472AC",
        "Action": "ListCustomBotConfig",
        "Version": "2020-12-09",
        "Service": "waf",
        "Region": "cn-shanghai"
    },
    "PageInfo": {
        "TotalCount": 1,
        "PageSize": 10,
        "CurrentPage": 1,
        "Count": 1
    },
    "Result": [
        {
            "Id": 41067,
            "BotType": "test",
            "Description": "test",
            "Action": "block",
            "Enable": 1,
            "UpdateTime": "2023-09-27T07:04:22+08:00",
            "Advanced": 1,
            "Accurate": {
                "Logic": 1,
                "AccurateRules": [
                    {
                        "HttpObj": "request.schema",
                        "ObjType": 0,
                        "Property": 0,
                        "Opretar": 2,
                        "ValueString": "http"
                    }
                ]
            },
            "RuleTag": "K000000041067"
        }
    ]
}