1. 接口描述
接口请求域名: waf.tencentcloudapi.com 。
clb-waf中添加防护域名
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateHost。 |
Version | 是 | String | 公共参数,本接口取值:2018-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo 。 |
Host | 是 | HostRecord | 防护域名配置信息 示例值:{ "Status": "1", "Engine": "1", "Domain": "lucainfo.qcloudwaf.com", "DomainId": "waf-d4foqwZy", "LoadBalancerSet": [ { "Protocol": "HTTP", "Zone": "1", "Region": "gz", "LoadBalancerName": "门户", "ListenerId": "lbl-87vxk72", "Vip": "127.0.0.1", "ListenerName": "监听器测试", "LoadBalancerId": "lb-2s7f791x", "Vport": "80" } ], "Level": "1", "MainDomain": "snv.vom", "Region": "cd", "FlowMode": "1", "State": "1", "ClsStatus": "1", "IsCdn": "1", "Mode": "1", "Edition": "clb-waf" } |
InstanceID | 否 | String | 实例id 示例值:waf_2kl34sf9ads9ad3s |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DomainId | String | 新增防护域名ID 示例值:waf-uEvTJG67 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加负载均衡型WAF域名
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHost
<公共请求参数>
{
"InstanceID": "waf_2kzgm331pk3213",
"Host": {
"Status": "1",
"Engine": "1",
"Domain": "lucainfo.qcloudwaf.com",
"DomainId": "waf-d4foqwZy",
"LoadBalancerSet": [
{
"Protocol": "HTTP",
"Zone": "1",
"Region": "gz",
"LoadBalancerName": "门户",
"ListenerId": "lbl-87vxk72",
"Vip": "127.0.0.1",
"ListenerName": "监听器测试",
"LoadBalancerId": "lb-2s7f791x",
"Vport": "80"
}
],
"Level": "1",
"MainDomain": "snv.vom",
"Region": "cd",
"FlowMode": "1",
"State": "1",
"ClsStatus": "1",
"IsCdn": "1",
"Mode": "1",
"Edition": "clb-waf"
}
}
输出示例
{
"Response": {
"RequestId": "97720395-7456-4a21-bcd9-1f32a7deaa90",
"Error": {
"Code": "ResourceInUse",
"Message": "DomainExisted"
}
}
}
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 | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |