1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
批量新增封禁或放通规则。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateBlockIgnoreRuleNew。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| RuleType | 是 | Integer | 规则类型:1 IP 封禁,2 IP 放通,3 域名放通,4 情报放通,5 资产放通,6 自定义放通。 示例值:1 |
| Rules.N | 是 | Array of BanAndAllowRule | 待新增规则列表;可为空,空数组返回成功且不新增规则。 |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
| CoverDuplicate | 否 | Integer | 互斥列表冲突处理,仅 RuleType=1 或 2 生效。0 表示保留已有互斥规则并跳过冲突新增项;1 表示保留新增项并删除同 IP、同方向的互斥规则;省略时不处理互斥冲突。填写本字段时,同一请求内相同 Ioc 会合并为一项,DirectionList 按输入顺序合并,时间和备注采用首次出现项的值。已有同类型、同 Ioc 规则的方向会与本次方向合并,其它字段按本次请求更新。 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增永久 IP 封禁规则
将一个 RFC 5737 文档地址添加到互联网出站封禁列表;不覆盖已有冲突规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "192.0.2.10",
"DirectionList": "0",
"EndTime": "3000-01-01 00:00:00",
"Comment": "永久 IP 封禁示例"
}
],
"RuleType": 1,
"CoverDuplicate": 0
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}
示例2 新增 IP 封禁并替换互斥规则
新增一条出站封禁规则;如放通列表中已有同 IP、同方向规则,CoverDuplicate=1 会保留本次封禁并删除冲突放通规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "203.0.113.20",
"DirectionList": "0",
"EndTime": "3000-01-01 00:00:00",
"Comment": "替换互斥规则示例"
}
],
"RuleType": 1,
"CoverDuplicate": 1
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000005"
}
}
示例3 批量新增定时 IP 封禁规则
在一次请求中新增两条仅入站定时封禁规则;每条规则独立指定 IOC、方向和结束时间,不覆盖已有冲突规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "192.0.2.211",
"DirectionList": "1",
"EndTime": "2099-01-01 00:00:00",
"Comment": "批量定时封禁示例一"
},
{
"Ioc": "192.0.2.212",
"DirectionList": "1",
"EndTime": "2099-01-02 00:00:00",
"Comment": "批量定时封禁示例二"
}
],
"RuleType": 1,
"CoverDuplicate": 0
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000004"
}
}
示例4 新增 IP 放通规则
将一个 RFC 5737 文档地址添加到互联网入站放通列表;不覆盖已有冲突规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "192.0.2.20",
"DirectionList": "1",
"EndTime": "3000-01-01 00:00:00",
"Comment": "IP 放通示例"
}
],
"RuleType": 2,
"CoverDuplicate": 0
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000008"
}
}
示例5 新增域名放通规则
新增一条互联网出站域名放通规则。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "example.com",
"DirectionList": "0",
"EndTime": "3000-01-01 00:00:00",
"Comment": "域名放通示例"
}
],
"RuleType": 3
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000006"
}
}
示例6 新增情报放通规则
将一个 IP 情报对象添加到互联网出入站放通列表。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "192.0.2.40",
"DirectionList": "0,1",
"EndTime": "3000-01-01 00:00:00",
"Comment": "情报放通示例"
}
],
"RuleType": 4
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000009"
}
}
示例7 新增资产放通规则
将 DescribeCfwAssets 返回的一个 CVM 实例添加到内网源和内网目的放通列表;Ioc 应替换为当前账号 assets[].instance_id。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "ins-xxxxxxxx",
"DirectionList": "5,6",
"EndTime": "3000-01-01 00:00:00",
"Comment": "资产放通示例"
}
],
"RuleType": 5
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000010"
}
}
示例8 新增自定义放通规则
新增一条私网源到私网目的的 VPC 防火墙自定义放通规则。Ioc 必须显式传空字符串,DirectionList 必须显式传非空值;IdsRuleId 应替换为 DescribeIpsRuleListNew 返回的现有规则 ID。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "",
"DirectionList": "5,6",
"EndTime": "3000-01-01 00:00:00",
"Comment": "自定义放通规则示例",
"FwType": 4,
"CustomRule": {
"SrcIP": "10.0.0.11",
"DstIP": "10.0.0.12",
"IdsRuleId": "20001",
"IdsRuleName": "自定义放通规则示例"
}
}
],
"RuleType": 6,
"CoverDuplicate": 0
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000007"
}
}
示例9 新增多引擎自定义放通规则
用户要求同一条自定义策略应用于互联网边界、NAT 和 VPC 防火墙时,调用 DescribeCfwAssets 取资产 IP 作为 SrcIP,调用 DescribeIpsRuleListNew 取 Data[].RuleID;FwType=15 表示请求旁路、NAT、VPC 和串行引擎,服务会按源和目的地址实际适用的引擎收窄。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBlockIgnoreRuleNew
{
"Rules": [
{
"Ioc": "",
"DirectionList": "0,1",
"EndTime": "3000-01-01 00:00:00",
"Comment": "多引擎自定义放通规则",
"FwType": 15,
"CustomRule": {
"SrcIP": "10.0.0.10",
"DstIP": "198.51.100.20",
"IdsRuleId": "20001",
"IdsRuleName": "多引擎自定义放通规则"
}
}
],
"RuleType": 6,
"CoverDuplicate": 0
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000011"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。