1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
获取负载均衡绑定的WAF信息,可以根据租户负载均衡实例ID、负载均衡监听器ID、负载均衡的域名信息来查询对应绑定的 Waf的状态信息。
查询的范围:负载均衡实例ID、负载均衡实例ID+监听器ID、负载均衡实例ID+监听器ID+域名。
可能的错误码:ResourceNotFound(没有找到对应的资源)、UnsupportedRegion(目前clb-waf只支持北京、广州、上海、成都、重庆、香港地域)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeWafInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo 。 |
Params.N | 是 | Array of ClbHostsParams | CLB回调WAF接口(获取、删除)的参数 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 返回的WAF信息数组的长度,为0则表示没有查询到对应的信息 |
HostList | Array of ClbHostResult | 对应的WAF信息的数组。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取负载均衡绑定的WAF信息
输入示例
https://waf.tencentcloudapi.com/?Action=DescribeWafInfo
&Params.0.AppId=251006578
&Params.0.LoadBalancerId=lb-A8VF445
&<公共请求参数>
&<公共请求参数>
输出示例
{
"Response": {
"HostList": [
{
"LoadBalancer": {
"LoadBalancerId": "A8VF445",
"LoadBalancerName": "waftt_test",
"ListenerId": "8rI9f73",
"ListenerName": "test_listener44_name",
"Vip": "203.195.240.4",
"Vport": 80,
"Region": "gz",
"Zone": "广州4区",
"Protocol": "http"
},
"Domain": "lsd.qcloudwaf.com",
"DomainId": "waf-MyBQKIZe",
"Status": 1,
"FlowMode": 0
}
],
"RequestId": "4bcd4d73-f743-466f-a905-205bdd509bec"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |