1. 接口描述
接口请求域名： cfw.tencentcloudapi.com 。
添加互联网边界访问控制规则
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddAclRule。 |
| Version | 是 | String | 公共参数，本接口取值：2019-09-04。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Rules.N | 是 | Array of CreateRuleItem | 需要添加的访问控制规则列表 示例值：[ { "SourceContent": "0.0.0.0/0", "SourceType": "net", "Description": "", "TargetContent": "www.qq.com", "TargetType": "domain", "Protocol": "HTTP", "RuleAction": "accept", "Port": "-1/-1", "Direction": 0, "OrderIndex": 1, "Scope": "serial", "RuleSource": 0, "ParamTemplateId": "" } ] |
| From | 否 | String | 添加规则的来源，一般不需要使用，值insert_rule 表示插入指定位置的规则；值batch_import 表示批量导入规则；为空时表示添加规则 示例值：batch_import |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RuleUuid | Array of Integer | 创建成功后返回新策略ID列表 示例值：[8888, 8889] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加互联网边界访问控制规则
添加互联网边界访问控制规则
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAclRule
<公共请求参数>
{
"Rules": [
{
"SourceContent": "0.0.0.0/0",
"SourceType": "net",
"Description": "pro",
"TargetContent": "www.qq.com",
"TargetType": "domain",
"Protocol": "HTTP",
"RuleAction": "accept",
"Port": "-1/-1",
"Direction": 0,
"OrderIndex": 1,
"Scope": "serial",
"RuleSource": 0
}
]
}输出示例
{
"Response": {
"RuleUuid": [
0
],
"RequestId": "3f60a76f-0f44-4b58-bf98-615cbbc59ede"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
