AddControlPolicy - 创建互联网边界流量控制网关访问控制策略--云防火墙-火山引擎

文档中心

立即注册

导航

AddControlPolicy - 创建互联网边界流量控制网关访问控制策略

最近更新时间：2024.07.15 11:06:24首次发布时间：2024.03.28 17:09:33

创建互联网边界流量控制网关访问控制策略。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=AddControlPolicy&Version=2021-09-06

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	AddControlPolicy	要执行的操作，取值：AddControlPolicy。
Version	String	是	2021-09-06	API的版本，取值：2021-09-06。

Body

参数	类型	是否必填	示例值	描述
Direction	String	是	in	访问控制策略的流量方向： in：外对内流量访问控制 out：内对外流量访问控制
Prio	Integer	否	1	访问控制策略优先级： 0: 最低优先级 1: 最高优先级其他: 其他优先级默认是最低优先级
Source	String	是	192.168.0.1/32	访问控制策略中的源地址：当SourceType为 net 时，Source为源CIDR地址。例如：192.168.1.1/32 当SourceType为 group 时，Source为源地址簿的uuid列表，最多支持50个地址簿,多个地址簿用英文逗号分隔。例如：f04ac7ce-628b-4cb7-be61-310222b7**, f04ac7ce-628b-4cb7-be61-310222b7** 当SourceType为location时，Source为源区域，多个地域通过英文逗号分隔。例如：BJ11, ZB
SourceType	String	是	net	访问控制策略中的源地址类型： net：源网段(cidrv4) group：源地址簿 location：源区域
Destination	String	是	192.168.0.2/32	访问控制策略中的目的地址：当DestinationType为net时，Destination为目的CIDR地址。例如：192.168.0.2/32 当DestinationType为group时，Destination为目的址簿的uuid列表，多个地址簿用英文逗号分隔。例如：f04ac7ce-628b-4cb7-be61-310222b7**, f04ac7ce-628b-4cb7-be61-310222b7** 当DestinationType为location时，Destination为目的区域，多个地域用英文逗号分隔。例如：BJ11, ZB 当DestinationType为Domain时，Destination为目的域名。例如：www.baidu.com
DestinationType	String	是	net	访问控制策略中的目的地址类型： net：目的网段(CIDR) group：目的地址簿 location：目的区域 domain：目的域名
DestPort	String	否	22/22	访问控制策略中的目的端口。格式为单个端口22，端口范围100/200：当协议类型为ICMP/ALL时，取值为空当DestPortType为group时，取值为端口地址簿的uuid列表，多个地址簿通过英文逗号分隔当DestPortType为port时，取值为端口范围
DestPortType	String	否	port	访问控制策略的目的端口类型： port：端口 group：端口地址簿
Proto	String	是	TCP	访问控制策略中的协议类型。当DestinationType为domain时，Proto只能是TCP： ICMP TCP UDP ANY：(任何协议)
Action	String	是	accept	访问控制策略的动作： accept：放行 deny：阻断 monitor：观察
Status	Boolean	否	false	访问控制策略的开关状态。默认为false，不开启。 true：开启 false：关闭
Description	String	否	测试	访问控制策略的描述信息。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数	类型	示例值	描述
RuleId	String	f04ac7ce-628b-4cb7-be61-310222b7****	添加成功后返回访问控制策略的唯一标识。

请求示例

POST /?Action=AddControlPolicy&Version=2021-09-06 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240711T081413Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240711/cn-beijing/fw_center/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Prio": 0,
  "Direction": "in",
  "SourceType": "net",
  "Source": "192.168.1.1/32",
  "DestinationType": "net",
  "Destination": "192.168.2.1/32",
  "DestPortType": "port",
  "DestPort": "22",
  "Proto": "TCP",
  "Action": "accept",
  "Description": "test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024071116144305518916004030****",
        "Version": "2021-09-06",
        "Service": "fw_center",
        "Region": "cn-beijing"
        "Action": "AddControlPolicy"
    },
    "Result": {
        "RuleId": "12ce4594-c328-*****"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	BadRequest	错误的请求。请检查http请求或者联系管理员！	请求无法被正确地解析，请重新构建请求，或者通过工单联系相关人员进行处理。
400	InvalidParameter	非法的参数。请检查%s。	请求中缺乏某个参数或者某个参数校验失败，请参考错误信息，根据 API 接口文档修改对应的参数。
400	NotFound.Resource	资源未找到。请检查%s。	请求需要操作的资源未找到，请参考错误信息，检查请求中的资源是否已被删除。
400	NotMatch.ResourceType	资源类型不匹配。请检查%s。	请求需要操作的资源类型与接口要求不符，请根据API文档检查请求中的资源类型是否符合要求。
400	Exceed.ResourceLimit	资源套餐容量不足。请检查%s。	您的资源套餐容量不足，当前操作无法执行。请参考错误信息，升级套餐内相应资源后重新操作。
500	InternalError	内部错误。请联系管理员！	请求过程中发生了一些非预期的错误，请通过工单联系相关人员进行处理。