获取用户规则白名单列表
最近更新时间: 2024-09-03 18:49:50
1. 接口描述
接口请求域名: ngwaf.api3.cloud.sunhongs.com。
获取用户规则白名单列表
默认接口请求频率限制:20次/秒。
接口更新时间:2023-10-12 15:05:33。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeAttackWhiteRule |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-01-25 |
| Region | 是 | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Domain | 是 | 否 | String | 需要查询的域名 |
| By | 否 | 否 | String | 排序字段,支持user_id, signature_id, modify_time |
| Order | 否 | 否 | String | 排序方式 |
| Offset | 是 | 否 | Uint64 | 分页 |
| Limit | 是 | 否 | Uint64 | 每页容量 |
| Filters | 否 | 否 | Array of FiltersItemNew | 筛选条件,支持SignatureId, MatchContent |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Uint64 | 规则总数 |
| List | UserWhiteRule | 规则白名单列表 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| ResourcesSoldOut | |
| InvalidParameter.InvalidCertificate | |
| InvalidParameter.QueryCertBySSLIDFailed | |
| UnsupportedOperation | |
| AuthFailure | |
| RequestLimitExceeded | |
| DryRunOperation | |
| OperationDenied | |
| InternalError.DBErr |