Web 应用防火墙 IP黑白名单新增接口-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

Waf IP黑白名单新增接口

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateIpAccessControl。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	具体域名如：test.qcloudwaf.com 全局域名为：global 示例值：test.qcloudwaf.com
IpList.N	是	Array of String	ip参数列表示例值：["192.16.8.1.1","192.168.2.1"]
ActionType	是	Integer	42为黑名单，40为白名单示例值：42
InstanceId	否	String	实例Id 示例值：waf_2kxq5hru00n2dxmx
Edition	否	String	WAF实例类型，sparta-waf表示SAAS型WAF，clb-waf表示负载均衡型WAF 示例值：clb-waf
SourceType	否	String	可选值为：batch（批量添加）、bot（BOT流量分析中的BOT详情列表中添加时）、cc（在攻击日志列表中对攻击类型为CC的IP添加时）、custom（非批量添加时的默认值）示例值：custom
Note	否	String	备注示例值：备注
JobType	否	String	规则执行的方式，TimedJob为定时执行，CronJob为周期执行示例值：TimedJob
JobDateTime	否	JobDateTime	定时配置详情示例值：{ "Timed": [ { "StartDateTime": 1711618518, "EndDateTime": 1711918518 } ], "Cron": [ { "Day": 12, "WDay": 2, "StartTime": "12:11", "EndTime": "21:00" } ], "TimeTZone": "UTC+8" }

3. 输出参数

参数名称	类型	描述
RuleId	Integer	新增的规则对应的ID 示例值：55211245
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 新增IP黑白名单

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpsertIpAccessControlV2
<公共请求参数>

{
    "InstanceId": "waf_0xabc",
    "Domain": "www.qcloudwaf.com",
    "IpList": [
        "192.168.1.1",
        "192.168.2.1"
    ],
    "Edition": "clb-waf",
    "ValidTS": 1680570420,
    "ActionType": 42,
    "SourceType": "custom"
}

输出示例

{
    "Response": {
        "RuleId": 55201922,
        "RequestId": "fea2e723-002b-40e6-8297-7c54455cb7d6"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.TheNumberOfAddedBlackAndWhiteListExceedsTheUpperLimit	黑白名单添加数超过上限
InternalError	内部错误。
InternalError.DBErr	DBErr
LimitExceeded	超过配额限制。
LimitExceeded.SpecificationErr	SpecificationErr
UnsupportedOperation	操作不支持。