增加访问控制(自定义策略)
最近更新时间: 2024-10-18 10:38:31
1. 接口描述
接口请求域名: ngwaf.api3.fincloud.tencent.cn。
增加访问控制(自定义策略)
默认接口请求频率限制:20次/秒。
接口更新时间:2023-09-05 09:16:59。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:AddCustomRule |
Version | 是 | 否 | String | 公共参数,本接口取值:2018-01-25 |
Region | 是 | 否 | String | 公共参数,本接口不需要传递此参数。 |
Edition | 否 | 否 | String | 此参数对外不可见。 WAF实例类型,sparta-waf表示SAAS型WAF,clb-waf表示负载均衡型WAF |
Bypass | 否 | 否 | String | 此参数对外不可见。 放行的详情 |
EventId | 否 | 否 | String | 此参数对外不可见。 添加规则的来源,默认为空 |
Name | 是 | 否 | String | 此参数对外不可见。 规则名称 |
SortId | 是 | 否 | String | 此参数对外不可见。 优先级 |
Redirect | 否 | 否 | String | 此参数对外不可见。 如果动作是重定向,则表示重定向的地址;其他情况可以为空 |
ExpireTime | 是 | 否 | String | 此参数对外不可见。 过期时间,单位为秒级时间戳,例如1677254399表示过期时间为2023-02-24 23:59:59. 0表示永不过期 |
Strategies | 是 | 否 | Array of Strategy | 此参数对外不可见。 策略详情 |
Domain | 是 | 否 | String | 此参数对外不可见。 需要添加策略的域名 |
ActionType | 是 | 否 | String | 此参数对外不可见。 动作类型,1代表阻断,2代表人机识别,3代表观察,4代表重定向 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Success | ResponseCode | 此参数对外不可见。 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败 |
RuleId | Int64 | 此参数对外不可见。 添加成功的规则ID |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InternalError | |
LimitExceeded | |
UnsupportedOperation | |
InternalError.DBErr | |
LimitExceeded.SpecificationErr |