获取自定义策略列表

最近更新时间: 2026-09-17 00:01:10

1. 接口描述

接口请求域名： waf.api3.fincloud.tencent.cn。

获取自定义策略列表

默认接口请求频率限制：20次/秒。

接口更新时间：2020-03-18 16:51:37。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeCustomRules
Version	是	否	String	公共参数，本接口取值：2018-01-25
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
Domain	是	否	String	域名示例值：
Edition	否	否	String	clb-waf或者sparta-waf 示例值：
Paging	是	否	DescribeCustomRulesPagingInfo	分页参数示例值：查看
ActionType	否	否	String	过滤参数：动作类型：0放行，1阻断，2人机识别，3观察，4重定向示例值：
Search	否	否	String	过滤参数：规则名称过滤条件示例值：

3. 输出参数

参数名称	类型	描述
RuleList	Array of DescribeCustomRulesRspRuleListItem	规则详情示例值：查看
TotalCount	String	规则条数示例值：
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。

5. 示例

示例1 获取自定义规则列表

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeCustomRules
&Domain=www.test.com
&Edition=clb-waf
&Paging.Offset=0
&Paging.Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
        "RuleList": [
            {
                "ActionType": "1",
                "Bypass": "geoip,cc,owasp,ai,antileakage",
                "CreateTime": "2020-02-20 14:00:12",
                "ExpireTime": "0",
                "Name": "test",
                "Redirect": "/",
                "RuleId": "17958569",
                "SortId": "100",
                "Status": "1",
                "Strategies": [
                    {
                        "Arg": "",
                        "CompareFunc": "ipmatch",
                        "Content": "1.1.1.2",
                        "Field": "IP"
                    }
                ]
            }
        ],
        "TotalCount": "1"
    }
}

示例2 带过滤参数返回结果为0的场景

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeCustomRules
&Domain=www.test.com
&Edition=clb-waf
&Paging.Offset=0
&Paging.Limit=10
&Search="1"
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "6d54d3c1-f60b-4766-bf2e-cb29738ed13d",
        "RuleList": [],
        "TotalCount": "0"
    }
}