1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
删除 IP 封禁规则,或清空封禁列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DeleteBlockIgnoreRuleNew。 |
| Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| DeleteAll | 是 | Integer | 删除模式,必传且只接受整数 0 或 1。0 表示按 Rules 中的 RuleType 与 Ioc 删除匹配记录;1 表示按 ShowType 清空对应列表,其中 blocklist 删除全部 RuleType=1 记录,whitelist 删除全部 RuleType>=2 记录,风险极高。 示例值:0 |
| CfwAiAgentOperationSource | 否 | String | AI操作来源 枚举值:
示例值:console |
| RuleType | 否 | Integer | 可省略。当前处理逻辑不读取该顶层字段;传入值不参与精确删除或整表删除的目标选择。 示例值:1 |
| Rules.N | 否 | Array of BanAndAllowRuleDel | 待删除规则列表。DeleteAll=0 时必填,每项删除所有与 RuleType、Ioc 匹配的记录;DirectionList 不参与目标匹配,但 RuleType=1、2、3 时必须使用 DescribeBlockIgnoreList 返回的完整方向列表。同一请求混合 RuleType 时,引擎更新使用最后一项的 RuleType。DeleteAll=1 时省略。 |
| ShowType | 否 | String | 列表类型,处理时必传且只接受 blocklist 或 whitelist。DeleteAll=1 时,blocklist 选择全部 RuleType=1 记录,whitelist 选择全部 RuleType>=2 记录;DeleteAll=0 时该字段仅校验取值,不限制 Rules 指定的删除目标。 示例值:blocklist |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 精确删除一个封禁 IP
使用 DescribeBlockIgnoreList 查询目标 IP,传顶层 Direction="",并将完全匹配项的 Ioc、RuleType 和完整 DirectionList 写入删除项。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteBlockIgnoreRuleNew
{
"DeleteAll": 0,
"Rules": [
{
"Ioc": "192.0.2.10",
"DirectionList": "0,1",
"RuleType": 1
}
],
"ShowType": "blocklist"
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}
示例2 精确删除一个放通 IP
用户要求删除放通列表中的 IP 时,调用 DescribeBlockIgnoreList,传顶层 Direction="" 和 ShowType=whitelist;将完全匹配项的 Ioc、RuleType 和完整 DirectionList 写入删除项。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteBlockIgnoreRuleNew
{
"DeleteAll": 0,
"Rules": [
{
"Ioc": "192.0.2.123",
"DirectionList": "0,1",
"RuleType": 2
}
],
"ShowType": "whitelist"
}
输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000002"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。