编辑自定义规则
最近更新时间: 2024-10-18 10:38:37
1. 接口描述
接口请求域名： ngwaf.api3.fincloud.tencent.cn。
编辑自定义规则
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-05 09:15:12。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifyCustomRule |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| RuleName | 是 | 否 | String | 编辑的规则名称 |
| SortId | 否 | 否 | Uint64 | 优先级，1~100的整数，数字越小，代表这条规则的执行优先级越高。<br>默认是100 |
| Strategies | 是 | 否 | Array of Strategy | 匹配条件数组 |
| ExpireTime | 否 | 否 | Uint64 | 规则生效截止时间，0：永久生效，其它值为对应时间的时间戳。<br>默认是0 |
| Edition | 否 | 否 | String | WAF的版本，clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF，默认是sparta-waf。 |
| Domain | 是 | 否 | String | 编辑的域名 |
| RuleId | 是 | 否 | Uint64 | 编辑的规则ID |
| RuleAction | 是 | 否 | String | 执行动作，0：放行、1：阻断、2：人机识别、3：观察、4：重定向 |
| Redirect | 否 | 否 | String | 动作为重定向的时候重定向URL，默认为"/" |
| Bypass | 否 | 否 | String | 放行时是否继续执行其它检查逻辑，继续执行地域封禁防护：geoip、继续执行CC策略防护：cc、继续执行WEB应用防护：owasp、继续执行AI引擎防护：ai、继续执行信息防泄漏防护：antileakage。如果多个勾选那么以,串接。<br>默认是"geoip,cc,owasp,ai,antileakage" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| ResourcesSoldOut | |
| UnsupportedOperation | |
| InternalError.DBErr |