华为云用户手册

云防火墙 CFW-新建服务组:请求示例

请求示例添加项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象为cfebd347-b655-4b84-b938-3c54317599b2，名称为ceshi的服务组。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "name" : "ceshi", "description" : "" }

云防火墙 CFW
云防火墙 CFW-新建服务组:URI

URI POST /v1/{project_id}/service-set 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id 表2 Query参数参数是否必选参数类型描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

云防火墙 CFW
云防火墙 CFW-更新黑白名单列表:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）表4 请求Body参数参数是否必选参数类型描述 direction 否 Integer 地址方向0：源地址1：目的地址 address_type 否 Integer 地址类型0：ipv4,1:ipv6,2:domain address 否 String ip地址 protocol 否 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1 port 否 String 端口 list_type 否 Integer 黑白名单类型4：黑名单，5：白名单枚举值： 4 5 object_id 否 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 description 否 String 描述

云防火墙 CFW 黑白名单管理
云防火墙 CFW-更新黑白名单列表:URI

URI PUT /v1/{project_id}/black-white-list/{list_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id list_id 是 String 黑白名单列表id 表2 Query参数参数是否必选参数类型描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

云防火墙 CFW 黑白名单管理
云防火墙 CFW-更新黑白名单列表:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 data IdObject object 更新黑白名单响应data 表6 IdObject 参数参数类型描述 id String id值 name String 名称状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

云防火墙 CFW 黑白名单管理
云防火墙 CFW-更新黑白名单列表:请求示例

请求示例更新项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的白名单为方向为源地址，地址为1.1.1.1，协议类型为tcp，端口为1的ipv4的tcp https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-list/9d80d070b6d44942af73c9c3d38e042b { "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "list_type" : 5, "direction" : 0, "address" : "1.1.1.1", "protocol" : 6, "port" : "1", "address_type" : 0 }

云防火墙 CFW 黑白名单管理
云防火墙 CFW-查询地址组列表:请求示例

请求示例查询项目id为5c69cf330cda42369cbd726ee1bc5e76，防护对象id为8a41d6a5-f215-428a-a76c-dc923b5d599a的第一页的ip地址组信息 https://{Endpoint}/v1/5c69cf330cda42369cbd726ee1bc5e76/address-sets?object_id=8a41d6a5-f215-428a-a76c-dc923b5d599a&limit=10&offset=0

云防火墙 CFW
云防火墙 CFW-查询地址组列表:响应示例

响应示例状态码： 200 OK { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "address_set_type" : 0, "object_id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", "address_type" : 0, "description" : "", "name" : "test", "ref_count" : 0, "set_id" : "50da1eff-e58d-4380-b899-a78f94137d3b" } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

云防火墙 CFW
云防火墙 CFW-查询地址组列表:URI

URI GET /v1/{project_id}/address-sets 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id 表2 Query参数参数是否必选参数类型描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 key_word 否 String 关键字 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 address 否 String ip地址 address_type 否 Integer 地址类型0 ipv4,1 ipv6 枚举值： 0 1 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 query_address_set_type 否 Integer 查询地址组类型，0表示自定义地址组，1表示预定义地址组 address_set_type 否 Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组

云防火墙 CFW
云防火墙 CFW-查询地址组列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 data data object 查询地址组列表返回数据表5 data 参数参数类型描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 总数 records Array of records objects 地址组列表表6 records 参数参数类型描述 set_id String 地址组id ref_count Integer 引用次数 description String 描述信息 name String 地址组名称 address_type Integer 地址类型0 ipv4,1 ipv6 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 address_set_type Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

云防火墙 CFW
云防火墙 CFW-删除域名组:请求示例

请求示例删除项目id为9d80d070b6d44942af73c9c3d38e0429，防火墙id为7a004e79-0b8b-4679-ab20-267f3946e8ba下的域名组，域名组id为89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/89bce6a4-9b59-4d7a-b5f9-cac5ac16d88a?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default

云防火墙 CFW
云防火墙 CFW-删除域名组:URI

URI DELETE /v1/{project_id}/domain-set/{set_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id set_id 是 String 域名组id 表2 Query参数参数是否必选参数类型描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

云防火墙 CFW
云防火墙 CFW-批量删除服务组成员信息:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）表4 请求Body参数参数是否必选参数类型描述 set_id 是 String 服务组id service_item_ids 是 Array of strings 服务组成员id列表

云防火墙 CFW
云防火墙 CFW-批量删除服务组成员信息:请求示例

请求示例删除项目id为9d80d070b6d44942af73c9c3d38e0429的服务组id为688faf62-20fc-4ca6-b9f9-6fbc518df5ae下的服务组成员f837f7ae-22c9-449d-a99c-4be24533e243 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "set_id" : "688faf62-20fc-4ca6-b9f9-6fbc518df5ae", "service_item_ids" : [ "f837f7ae-22c9-449d-a99c-4be24533e243" ] }

云防火墙 CFW
云防火墙 CFW-批量删除服务组成员信息:URI

URI DELETE /v1/{project_id}/service-items 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id 表2 Query参数参数是否必选参数类型描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

云防火墙 CFW
云防火墙 CFW-弹性IP列表查询:响应示例

响应示例状态码： 200 EIP数据查询返回值 { "data" : { "limit" : 200, "offset" : 0, "records" : [ { "associate_instance_type" : "PORT", "device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e", "device_name" : "test", "device_owner" : "compute:cn-north-7c", "domain_id" : "7d07807209524a4280266db9df63c4fa", "enterprise_project_id" : "0", "fw_domain_id" : "7d07807209524a4280266db9df63c4fa", "fw_enterprise_project_id" : "default", "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "fw_instance_name" : "test", "id" : "465b34fe-e017-4831-a21c-9c6c753bb1f2", "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "public_ip" : "100.85.223.15", "status" : 0, "tags" : "combined_order_id=CBR CS 23040615138M2KW912" } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00109004", "error_msg" : "HTTP请求错误" }

云防火墙 CFW
云防火墙 CFW-弹性IP列表查询:请求示例

请求示例查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为cfebd347-b655-4b84-b938-3c54317599b2，非同步的第一页的数据 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/eips/protect?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&sync=0

云防火墙 CFW
云防火墙 CFW-弹性IP列表查询:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 data EipResponseData object 查询eip返回data 表5 EipResponseData 参数参数类型描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 total Integer 总数 records Array of EipResource objects eip资源记录表6 EipResource 参数参数类型描述 id String 弹性公网ID public_ip String 弹性公网IP status Integer EIP防护状态，0表示防护中，1表示未防护枚举值： 0 1 public_ipv6 String 弹性公网IP,IPV6 enterprise_project_id String 企业项目id device_id String 设备id device_name String 设备名称 device_owner String 设备拥有者 associate_instance_type String 关联实例类型 fw_instance_name String 防火墙名称 fw_instance_id String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。 fw_enterprise_project_id String Eip绑定的防火墙企业项目id object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 tags String 标签列表 domain_id String EIP所属用户 owner String 所属用户的名称 fw_domain_id String 防火墙所属用户状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

云防火墙 CFW
云防火墙 CFW-弹性IP列表查询:URI

URI GET /v1/{project_id}/eips/protect 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目ID 最小长度：32 最大长度：32 表2 Query参数参数是否必选参数类型描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。最小长度：36 最大长度：36 key_word 否 String 弹性公网ID/弹性公网IP 最小长度：0 最大长度：255 status 否 String 防护状态 null-全部 0-开启防护 1-关闭防护枚举值： null 0 1 sync 否 Integer 是否同步租户EIP数据 0-不同步 1-同步枚举值： 0 1 limit 是 Integer 每页显示个数，范围为1-1024 最小值：0 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 最小值：0 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 device_key 否 String 设备键 address_type 否 Integer 地址类型0 ipv4,1 ipv6 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 fw_key_word 否 String 所绑定防火墙id防火墙名称 eps_id 否 String 弹性公网ip的企业项目id tags 否 String 标签列表信息

云防火墙 CFW
云防火墙 CFW-查询流日志:响应示例

响应示例状态码： 200 OK { "data" : { "limit" : 10, "records" : [ { "app" : "SSH", "bytes" : 34.5, "direction" : "out2in", "dst_ip" : "100.95.148.49", "dst_port" : 22, "end_time" : 1664155493000, "log_id" : "76354", "packets" : 25, "protocol" : "TCP", "src_ip" : "100.93.27.17", "src_port" : 49634, "start_time" : 1664155428000 } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00500002", "error_msg" : "时间间距错误" }

云防火墙 CFW
云防火墙 CFW-查询流日志:请求示例

请求示例查询项目id为9d80d070b6d44942af73c9c3d38e0429防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318，起点时间为1663555012000，终点时间为1664159798000的首页的流日志。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/flow?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663555012000&end_time=1664159798000&limit=10

云防火墙 CFW
云防火墙 CFW-查询流日志:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 data data object 查询流日志返回值表5 data 参数参数类型描述 total Integer 返回数量 limit Integer 每页显示个数，范围为1-1024 records Array of records objects 记录表6 records 参数参数类型描述 bytes Double 字节 direction String 方向，有内到外和外到内两种枚举值： out2in in2out packets Integer 包 start_time Long 开始时间 end_time Long 结束时间 log_id String 文档ID src_ip String 源IP src_port Integer 源端口 dst_ip String 目的IP app String 应用协议 dst_port Integer 目的端口 protocol String 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 dst_host String 目标主机 dst_region_id String 目的地域id dst_region_name String 目的地域名称 src_region_id String 源地域id src_region_name String 源地域名称状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

云防火墙 CFW
云防火墙 CFW-查询流日志:URI

URI GET /v1/{project_id}/cfw/logs/flow 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id 表2 Query参数参数是否必选参数类型描述 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。 direction 否 String 方向 log_type 否 String 日志类型枚举值： internet vpc nat start_time 是 Long 开始时间 end_time 是 Long 结束时间 src_ip 否 String 源IP src_port 否 Integer 源端口最小值：0 最大值：65535 dst_ip 否 String 目的IP dst_port 否 Integer 目的端口最小值：0 最大值：65535 protocol 否 String 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空枚举值： 6 17 1 58 app 否 String 应用协议 log_id 否 String 文档ID，首页时为null，非首页时不为null next_date 否 Long 日期，首页时为null，非首页时不为null offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit 是 Integer 每页显示个数，范围为1-1024 最小值：1 最大值：1024 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 dst_host 否 String 目的主机 src_region_name 否 String 源region名称 dst_region_name 否 String 目的region名称

云防火墙 CFW
云防火墙 CFW-更新地址组信息:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）表4 请求Body参数参数是否必选参数类型描述 name 否 String 地址组名称 description 否 String 地址组描述 address_type 否 Integer 地址类型0 ipv4,1 ipv6,2 domain 枚举值： 0 1 2

云防火墙 CFW
云防火墙 CFW-更新地址组信息:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 data UpdateAddressSetResponseData object 更新地址组返回数据表6 UpdateAddressSetResponseData 参数参数类型描述 id String Id 状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：8 最大长度：36 error_msg String 错误描述最小长度：2 最大长度：512

云防火墙 CFW
云防火墙 CFW-更新地址组信息:请求示例

请求示例更新项目id为9d80d070b6d44942af73c9c3d38e0429下的地址组id为cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16的地址组的名称改为ABCD，地址组类型改为 ipV4 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 { "name" : "ABCD", "description" : "", "address_type" : 0 }

云防火墙 CFW
云防火墙 CFW-更新地址组信息:URI

URI PUT /v1/{project_id}/address-sets/{set_id} 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目id set_id 是 String 地址组id 表2 Query参数参数是否必选参数类型描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

云防火墙 CFW
云防火墙 CFW-批量删除Acl规则:响应示例

响应示例状态码： 200 批量删除规则返回值 { "data" : { "responseDatas" : [ { "name" : "test", "id" : "0475c516-0e41-4caf-990b-0c504eebd73f" }, { "name" : "test2", "id" : "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" } ] } }

云防火墙 CFW
云防火墙 CFW-批量删除Acl规则:请求示例

请求示例删除项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的防护对象 id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b的规则，规则id为0475c516-0e41-4caf-990b-0c504eebd73f和8662868e-fe7e-4dfc-bfb1-ca4d73081ca6 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule { "rule_ids" : [ "0475c516-0e41-4caf-990b-0c504eebd73f", "8662868e-fe7e-4dfc-bfb1-ca4d73081ca6" ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b" }

云防火墙 CFW
云防火墙 CFW-批量删除Acl规则:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 data BatchDeleteAclRulesResponseData object 批量删除ACL规则返回值data 表6 BatchDeleteAclRulesResponseData 参数参数类型描述 responseDatas Array of BatchDeleteRuleInfo objects 批量删除规则返回data 表7 BatchDeleteRuleInfo 参数参数类型描述 name String acl名称 id String aclId

云防火墙 CFW

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线