添加精准白名单规则
最近更新时间: 2024-10-18 10:38:31
1. 接口描述
接口请求域名： ngwaf.api3.fincloud.tencent.cn。
增加精准白名单规则
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-05 09:16:58。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AddCustomWhiteRule |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Domain | 是 | 否 | String | 需要添加策略的域名 |
| Bypass | 是 | 否 | String | 放行的详情 |
| Name | 是 | 否 | String | 规则名称 |
| SortId | 是 | 否 | String | 优先级 |
| ExpireTime | 是 | 否 | String | 过期时间 |
| Strategies | 是 | 否 | Array of Strategy | 策略详情 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleId | Uint64 | 添加成功的规则ID |
| Success | ResponseCode | 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InternalError | |
| LimitExceeded | |
| UnsupportedOperation | |
| LimitExceeded.SpecificationErr |