1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
支持对封禁列表、放通列表如下操作：
批量增加封禁IP、放通IP/域名
批量删除封禁IP、放通IP/域名
批量修改封禁IP、放通IP/域名生效事件
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyBlockIgnoreList。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| RuleType | 是 | Integer | 1封禁列表 2 放通列表 示例值：1 |
| IOC.N | 是 | Array of IocListData | IP、Domain二选一（注：封禁列表，只能填写IP），不能同时为空 |
| IocAction | 是 | String | 可选值：delete（删除）、edit（编辑）、add（添加） 其他值无效 示例值：add |
| StartTime | 否 | String | 时间格式：yyyy-MM-dd HH:mm:ss，IocAction 为edit或add时必填 示例值：2020-04-23 18:56:16 |
| EndTime | 否 | String | 时间格式：yyyy-MM-dd HH:mm:ss，IocAction 为edit或add时必填，必须大于当前时间且大于StartTime 示例值：2020-04-30 18:56:16 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnMsg | String | 接口返回信息 示例值：success |
| ReturnCode | Integer | 接口返回错误码，0请求成功 非0失败 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 入侵防御-封禁列表/放通列表-增删改接口
支持对封禁列表、放通列表如下操作： 批量增加封禁IP、放通IP/域名 批量删除封禁IP、放通IP/域名 批量修改封禁IP、放通IP/域名生效事件
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyBlockIgnoreList
<公共请求参数>
{
"IOC": [
{
"IP": "192.168.1.1",
"Direction": 1,
"Domain": ""
}
],
"RuleType": 1,
"IocAction": "add",
"StartTime": "2021-04-16 18:01:09",
"EndTime": "3000-01-01 00:00:00"
}输出示例
{
"Response": {
"ReturnCode": 0,
"ReturnMsg": "success",
"RequestId": "cd0e1fdf-157d-438c-9bc8-75925e5d4e20"
}
}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 | 操作失败。 |
| InvalidParameter | 参数错误。 |
| LimitExceeded | 超过配额限制。 |
| UnauthorizedOperation | 未授权操作。 |