获取负载均衡绑定的WAF信息

最近更新时间: 2024-10-18 10:38:32

1. 接口描述

接口请求域名: ngwaf.api3.fincloud.tencent.cn。

获取负载均衡绑定的WAF信息,可以根据租户负载均衡实例ID、负载均衡监听器ID、负载均衡的域名信息来查询对应绑定的 Waf的状态信息。 查询的范围:负载均衡实例ID、负载均衡实例ID+监听器ID、负载均衡实例ID+监听器ID+域名。 可能的错误码:ResourceNotFound(没有找到对应的资源)、UnsupportedRegion(目前clb-waf只支持北京、广州、上海、成都、重庆、香港地域)。

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

接口更新时间:2023-09-14 14:16:59。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeWafInfo
Version String 公共参数,本接口取值:2018-01-25
Region String 公共参数,本接口不需要传递此参数。
Params Array of ClbHostsParams CLB回调WAF接口(获取、删除)的参数

3. 输出参数

参数名称 类型 描述
Total Uint64 此参数对外不可见。
返回的WAF信息数组的长度,为0则表示没有查询到对应的信息
HostList ClbHostResult 此参数对外不可见。
对应的WAF信息的数组。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter
InvalidParameterValue
MissingParameter
UnknownParameter
InternalError
UnauthorizedOperation
ResourceNotFound
LimitExceeded
ResourceUnavailable
ResourceInsufficient
FailedOperation
ResourceInUse
ResourcesSoldOut