1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
创建入侵防御白名单。先选择 RuleType，再按该类型填写 Rules[].Info；每条策略使用唯一 RuleName。创建成功后调用 DescribeWhiteRule，使用 RuleName+OperatorType 9 查询并精确核对 RuleName，取得 WhiteId。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateWhiteRule。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| RuleType | 是 | Integer | 使用 JSON integer 表示白名单类型，一次请求使用一种： - 2 精确外部 IP：Rules[].Info.SrcIP、Rules[].Info.DstIP 两个字段中恰好填写一个。 - 3 域名：填写 Rules[].Info.Ioc。 - 4 威胁情报：填写 Rules[].Info.Ioc，FwType=1。 - 5 资产：Rules[].Info.SrcIP、Rules[].Info.DstIP 两个字段中恰好填写一个，值取 DescribeCfwAssets 的 instance_id。 - 6 IPS 自定义：Rules[].Info.IdsRuleId 必填，Rules[].Info.SrcIP、Rules[].Info.DstIP 至少一项为具体 IP；FwType=16 时目的 IPv4 可带端口；FwType 包含 1 时具体 IP 至少一项属于当前账号资产。 - 8 IP 扩展：在 Rules[].Info 中填写 CIDR、端口或源/目的组合。 - 9 NDR 扩展：FwType=16，Rules[].Info 至少填写一个 UserAgent、Url、XForwardedFor、HostName、FileName、FileMd5；可组合 SrcIP、DstIP，搭配 IdsRuleId 时同时填写 SrcIP 或 DstIP。 示例值：8 |
| Rules.N | 是 | Array of IdsWhiteRule | JSON object 数组，至少一项；每项填写 1–50 个字符的 RuleName，且同一请求内名称唯一。列表内共用一个 RuleType，不同类型分次调用。Rules[].Info 多值字段按笛卡尔积展开，一次请求展开后最多 100 条。WhiteId 由服务端生成，Id 和 IdsRuleName 由服务端管理。 |
| CoverDuplicate | 否 | Integer | 使用 JSON integer。仅 RuleType=2 使用：0 或省略表示保留冲突封禁并跳过冲突项；1 表示删除同 IP、同方向冲突封禁后创建白名单，选择 1 前先确认该删除操作。其它 RuleType 省略本参数。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建精确源 IP 白名单
RuleType=2；Rules[].Info.SrcIP、DstIP 两个字段中恰好填写一个，CoverDuplicate 可省略。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteRule
{
"Rules": [
{
"RuleName": "办公出口 IP 加白",
"FwType": 31,
"Comment": "可信办公出口",
"EndTime": "3000-01-01 00:00:00",
"Info": {
"SrcIP": "198.51.100.201"
}
}
],
"RuleType": 2
}输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}示例2 创建域名白名单
RuleType=3，域名填写 Rules[].Info.Ioc。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteRule
{
"Rules": [
{
"RuleName": "可信业务域名",
"FwType": 31,
"EndTime": "3000-01-01 00:00:00",
"Info": {
"Ioc": "api.example.com"
}
}
],
"RuleType": 3
}输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}示例3 创建 CIDR 扩展白名单
RuleType=8 用于 CIDR/端口/组合；精确单 IP 用 RuleType=2。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteRule
{
"Rules": [
{
"RuleName": "可信源网段",
"FwType": 2,
"EndTime": "3000-01-01 00:00:00",
"Info": {
"SrcIP": "198.51.100.0/30"
}
}
],
"RuleType": 8
}输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}示例4 创建 NDR User-Agent 白名单
RuleType=9 且 FwType=16；多 UA 用 <#cfw-splite#>。
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateWhiteRule
{
"Rules": [
{
"RuleName": "可信扫描器 UA",
"FwType": 16,
"EndTime": "3000-01-01 00:00:00",
"Info": {
"UserAgent": "TrustedScanner/1.0"
}
}
],
"RuleType": 9
}输出示例
{
"Response": {
"RequestId": "00000000-0000-4000-8000-000000000001"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
