添加互联网边界规则
最近更新时间: 2024-09-03 18:50:00
1. 接口描述
接口请求域名: cfw.api3.cloud.sunhongs.com。
添加互联网边界规则
默认接口请求频率限制:20次/秒。
接口更新时间:2023-09-05 02:06:21。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:AddAcRule |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-09-04 |
| Region | 是 | 否 | String | 公共参数,本接口不需要传递此参数。 |
| ApplicationName | 否 | 否 | String | 七层协议,取值:<br>HTTP/HTTPS<br>TLS/SSL |
| Description | 是 | 否 | String | 访问控制策略的描述信息 |
| DestContent | 是 | 否 | String | 访问控制策略中的目的地址。取值:<br>当DestType为net时,DestContent为源IP地址或者CIDR地址。<br>例如:1.1.1.0/24<br><br>当DestType为template时,DestContent为源地址模板id。<br><br>当DestType为location时,DestContent为源区域。<br>例如["BJ11", "ZB"]<br><br>当DestType为instance时,DestContent为该实例id对应的公网ip。<br>例如ins-xxxxx<br><br>当DestType为domain时,DestContent为该实例id对应的域名规则。<br>例如*.qq.com<br><br>当DestType为vendor时,DestContent为所选择厂商的公网ip列表。<br>例如:aws,huawei,tencent,aliyun,azure,all代表以上五个 |
| DestType | 是 | 否 | String | 访问控制策略中的目的地址类型。取值:<br>net:目的IP或者网段(IP或者CIDR)<br>location:源区域<br>template:云防火墙地址模板<br>instance:实例id<br>vendor:云厂商<br>domain: 域名或者ip |
| Direction | 是 | 否 | String | 访问控制策略的流量方向。取值:<br>in:外对内流量访问控制<br>out:内对外流量访问控制 |
| Enable | 否 | 否 | String | 是否启用规则,默认为启用,取值:<br>true为启用,false为不启用 |
| OrderIndex | 是 | 否 | String | -1表示优先级最低,1表示优先级最高 |
| Port | 是 | 否 | String | 访问控制策略的端口。取值:<br>-1/-1:全部端口<br>80,443:80或者443 |
| Protocol | 否 | 否 | String | 访问控制策略中流量访问的协议类型。取值:TCP,目前互联网边界规则只能支持TCP,不传参数默认就是TCP |
| RuleAction | 是 | 否 | String | 访问控制策略中设置的流量通过云防火墙的方式。取值:<br>accept:放行<br>drop:拒绝<br>log:观察 |
| SourceContent | 是 | 否 | String | 访问控制策略中的源地址。取值:<br>当SourceType为net时,SourceContent为源IP地址或者CIDR地址。<br>例如:1.1.1.0/24<br><br>当SourceType为template时,SourceContent为源地址模板id。<br><br>当SourceType为location时,SourceContent为源区域。<br>例如["BJ11", "ZB"]<br><br>当SourceType为instance时,SourceContent为该实例id对应的公网ip。<br>例如ins-xxxxx<br><br>当SourceType为vendor时,SourceContent为所选择厂商的公网ip列表。<br>例如:aws,huawei,tencent,aliyun,azure,all代表以上五个 |
| SourceType | 是 | 否 | String | 访问控制策略中的源地址类型。取值:<br>net:源IP或网段(IP或者CIDR)<br>location:源区域<br>template:云防火墙地址模板<br>instance:实例id<br>vendor:云厂商 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ReturnCode | Int64 | 0代表成功,-1代表失败 |
| ReturnMsg | String | success代表成功,failed代表失败 |
| RuleUuid | Int64 | 创建成功后返回新策略的uuid |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | |
| InvalidParameter | |
| UnauthorizedOperation | |
| LimitExceeded | |
| UnsupportedOperation | |
| ResourceInUse | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| RequestLimitExceeded | |
| ResourceInsufficient | |
| ResourceUnavailable | |
| ResourceNotFound | |
| DryRunOperation | |
| OperationDenied | |
| ResourcesSoldOut | |
| InvalidParameterValue | |
| UnknownParameter |