1. 接口描述
此接口处于预下线状态 。
预计下线时间:2025-02-03 14:54:00
接口请求域名: cfw.tencentcloudapi.com 。
接口不再使用,已有新接口AddAclRule
添加互联网边界规则
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddAcRule。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
OrderIndex | 是 | String | -1表示优先级最低,1表示优先级最高 示例值:-1 |
RuleAction | 是 | String | 访问控制策略中设置的流量通过云防火墙的方式。取值: accept:放行 drop:拒绝 log:观察 示例值:accept |
Direction | 是 | String | 访问控制策略的流量方向。取值: in:外对内流量访问控制 out:内对外流量访问控制 示例值:in |
Description | 是 | String | 访问控制策略的描述信息 示例值:默认拒绝所有流量 |
SourceType | 是 | String | 访问控制策略中的源地址类型。取值: net:源IP或网段(IP或者CIDR) location:源区域 template:云防火墙地址模板 instance:实例id vendor:云厂商 示例值:net |
SourceContent | 是 | String | 访问控制策略中的源地址。取值: 当SourceType为net时,SourceContent为源IP地址或者CIDR地址。 例如:1.1.1.0/24 当SourceType为template时,SourceContent为源地址模板id。 当SourceType为location时,SourceContent为源区域。 例如["BJ11", "ZB"] 当SourceType为instance时,SourceContent为该实例id对应的公网ip。 例如ins-xxxxx 当SourceType为vendor时,SourceContent为所选择厂商的公网ip列表。 例如:aws,huawei,tencent,aliyun,azure,all代表以上五个 示例值:1.1.1.1 |
DestType | 是 | String | 访问控制策略中的目的地址类型。取值: net:目的IP或者网段(IP或者CIDR) location:源区域 template:云防火墙地址模板 instance:实例id vendor:云厂商 domain: 域名或者ip 示例值:domain |
DestContent | 是 | String | 访问控制策略中的目的地址。取值: 当DestType为net时,DestContent为源IP地址或者CIDR地址。 例如:1.1.1.0/24 当DestType为template时,DestContent为源地址模板id。 当DestType为location时,DestContent为源区域。 例如["BJ11", "ZB"] 当DestType为instance时,DestContent为该实例id对应的公网ip。 例如ins-xxxxx 当DestType为domain时,DestContent为该实例id对应的域名规则。 例如.qq.com 当DestType为vendor时,DestContent为所选择厂商的公网ip列表。 例如:aws,huawei,tencent,aliyun,azure,all代表以上五个 示例值:.qq.com |
Port | 是 | String | 访问控制策略的端口。取值: -1/-1:全部端口 80,443:80或者443 示例值:-1/-1 |
Protocol | 否 | String | 访问控制策略中流量访问的协议类型。取值:TCP,目前互联网边界规则只能支持TCP,不传参数默认就是TCP 示例值:TCP |
ApplicationName | 否 | String | 七层协议,取值: HTTP/HTTPS TLS/SSL 示例值:HTTP |
Enable | 否 | String | 是否启用规则,默认为启用,取值: true为启用,false为不启用 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RuleUuid | Integer | 创建成功后返回新策略的uuid 示例值:8888 |
ReturnCode | Integer | 0代表成功,-1代表失败 示例值:0 |
ReturnMsg | String | success代表成功,failed代表失败 示例值:success |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加互联网边界规则
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AddAcRule
<公共请求参数>
{
"OrderIndex": "-1",
"Description": "api test1",
"SourceType": "location",
"SourceContent": "cq50,sh31,tj12,bj11",
"DestType": "net",
"DestContent": "0.0.0.0/0",
"Enable": "true",
"Direction": "in",
"RuleAction": "accept",
"Port": "-1/-1",
"Protocol": "tcp"
}
输出示例
{
"Response": {
"RuleUuid": 8888,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
"ReturnCode": 0,
"ReturnMsg": "success"
}
}
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 | 操作不支持。 |