查询精准白名单规则

最近更新时间: 2024-09-03 18:49:50

1. 接口描述

接口请求域名: ngwaf.api3.cloud.sunhongs.com。

获取防护配置中的精准白名单策略列表

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

接口更新时间:2023-09-05 09:15:23。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:DescribeCustomWhiteRule
Version 是 否 String 公共参数,本接口取值:2018-01-25
Region 是 否 String 公共参数,本接口不需要传递此参数。
By 否 否 String 此参数对外不可见。
exp_ts或者mod_ts
Domain 是 否 String 此参数对外不可见。
域名
Offset 是 否 Uint64 此参数对外不可见。
偏移量
Limit 是 否 Uint64 此参数对外不可见。
容量
Filters 否 否 Array of FiltersItemNew 此参数对外不可见。
过滤数组,name可以是如下的值: RuleID,RuleName,Match
Order 否 否 String 此参数对外不可见。
asc或者desc

3. 输出参数

参数名称 类型 描述
RuleList DescribeCustomRulesRspRuleListItem 此参数对外不可见。
规则详情
TotalCount String 此参数对外不可见。
规则条数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter
InternalError
UnsupportedOperation
InternalError.DBErr