1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
创建访问控制规则
默认接口请求频率限制：10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateAcRules。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Data.N | 是 | Array of RuleInfoData | 创建规则数据 示例值：[{"OrderIndex":1,"SourceIp":"0.0.0.0","TargetIp":"1.1.1.1","Protocol":"http","Port":"80","Strategy":"0","SourceType":1,"Direction":0,"Detail":"andy创建的规则","TargetType":1,"Id":1,"LogId":"kYtiGTORZGin","City":1,"Country":1,"CloudCode":"1","IsRegion":1,"CityName":"广州","CountryName":"中国","RegionIso":"gb"}] |
| Type | 否 | Integer | 0：添加（默认），1：插入 示例值：0 |
| EdgeId | 否 | String | 边id 示例值：cfw-ieldx0io |
| Enable | 否 | Integer | 访问控制规则状态 示例值：1 |
| Overwrite | 否 | Integer | 0：添加，1：覆盖 示例值：0 |
| InstanceId | 否 | String | NAT实例ID, 参数Area存在的时候这个必传 示例值：ins-ettdxg5er |
| From | 否 | String | portScan: 来自于端口扫描, patchImport: 来自于批量导入 示例值：portScan |
| Area | 否 | String | NAT地域 示例值：ap-chongqing |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | Integer | 状态值，0:操作成功 示例值：0 |
| Info | String | 返回多余的信息 示例值：success |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建规则
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAcRules
<公共请求参数>
{
"Data": [
{
"OrderIndex": 17,
"SourceIp": "0.0.0.0/0",
"TargetIp": "0.0.0.0/0",
"Protocol": "TCP",
"Port": "-1/-1",
"Strategy": "0",
"Detail": "andy创建的规则",
"CloudCode": "1",
"SourceType": 1,
"TargetType": 1,
"Direction": 1,
"IsRegion": 0,
"Country": 0,
"City": 0,
"CityName": "chongqing",
"CountryName": "cn"
}
],
"Type": 0,
"EdgeId": "cfw-indf01efd",
"InstanceId": "ins-ifndf00e",
"Area": "ap-chongqing",
"Enable": 1
}输出示例
{
"Response": {
"Status": 0,
"Info": "success",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}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 | 超过配额限制。 |
