华为云用户手册

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data BlackWhiteListId object 更新黑白名单响应数据 表6 BlackWhiteListId 参数 参数类型 描述 id String 黑白名单id name String 黑白名单名称，为黑白名单的地址 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 更新黑白名单响应 { "data" : { "id" : "5d37afe6-c5b4-400d-8ff3-a8d6396d7ace", "name" : "10.1.1.10" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 direction 否 Integer 地址方向0：源地址1：目的地址 address_type 否 Integer 地址类型0：ipv4，1:ipv6 address 是 String ip地址 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1 port 否 String 端口 description 否 String 描述

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

URI PUT /v1/{project_id}/black-white-list/{list_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 list_id 是 String 黑白名单列表id，可通过查询黑白名单列表接口查询获得，通过返回值中的data.records.list_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

响应参数 状态码： 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 描述信息 address_type Integer 地址类型0 ipv4，1 ipv6 object_id String 防护对象id，是创建 云防火墙 后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 address_set_type Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 name String 地址组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 查询项目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

响应示例 状态码： 200 查询地址组列表返回值 { "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" : "实例状态错误" }

URI GET /v1/{project_id}/address-sets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 key_word 否 String 关键字，包括地址组名称或描述的一部分 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 address 否 String ip地址 address_type 否 Integer 地址类型0 ipv4，1 ipv6 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 query_address_set_type 否 Integer 查询地址组类型，0表示自定义地址组，1表示预定义地址组，当address_set_type不为0时，query_address_set_type为1时才可以生效。 address_set_type 否 Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组

请求示例 删除项目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

URI DELETE /v1/{project_id}/domain-set/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 set_id 是 String 域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 set_id 是 String 服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 service_item_ids 是 Array of strings 服务组成员id列表，服务组成员id可通过查询服务成员列表接口查询获得，通过返回值中的data.records.item_id（.表示各对象之间层级的区分）获得。

URI DELETE /v1/{project_id}/service-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

请求示例 删除项目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" ] }

URI PUT /v1/{project_id}/domain-set/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 set_id 是 String 域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。

请求示例 更新项目id为9d80d070b6d44942af73c9c3d38e0429下的防火墙id为7a004e79-0b8b-4679-ab20-267f3946e8ba的域名组id为94da194d-24b2-4f60-919e-cf0bc76c75b3，修改名称为test。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-set/94da194d-24b2-4f60-919e-cf0bc76c75b3?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "name" : "test", "description" : "" }

响应示例 状态码： 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:test", "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请求错误" }

请求示例 查询项目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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data EipResponseData object 查询eip返回data 表5 EipResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 total Integer 查询获得EIP列表总数 records Array of EipResource objects eip资源记录 表6 EipResource 参数 参数类型 描述 id String 弹性公网ID public_ip String 弹性公网IP status Integer EIP防护状态，0表示防护中，1表示未防护 public_ipv6 String 弹性公网IP,IPV6类型 enterprise_project_id String Eip所在账户企业项目id device_id String EIP绑定设备（如ecs，nat）id device_name String EIP绑定设备（如ecs，nat）名称 device_owner String EIP绑定设备（如ecs，nat）拥有者 associate_instance_type String 关联实例类型，包括：NATGW，ELB，PORT等。 fw_instance_name String 防火墙名称 fw_instance_id String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。 fw_enterprise_project_id String Eip绑定的防火墙企业项目id object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 tags String 标签列表 domain_id String EIP所属用户id，可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。 fw_domain_id String 防火墙所属用户，可通过获取账号、IAM用户、项目、用户组、区域、委托的名称和ID获取。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/eips/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 key_word 否 String 查询防护EIP列表关键字，可选用弹性公网ID和弹性公网IP status 否 String 防护状态 null-全部 0-开启防护 1-关闭防护 sync 否 Integer 是否同步租户EIP数据 0-不同步 1-同步 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 device_key 否 String 设备关键字，是eip绑定的资产的名称或id address_type 否 Integer 地址类型0 ipv4，1 ipv6 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 fw_key_word 否 String 防火墙关键字，可使用防火墙id或名称查询，可通过防火墙ID获取方式 eps_id 否 String 弹性公网ip的企业项目id，可通过如何获取企业项目ID获取，租户未开启企业项目时为0 tags 否 String 标签列表信息可通过查询EIP服务界面列表标签页签获得

响应参数 状态码： 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 方向，有内到外（in2out）和外到内（out2in）两种 packets Integer 字节包数 start_time Long 开始时间，以毫秒为单位的时间戳，如1718936272648 end_time Long 结束时间，以毫秒为单位的时间戳，如1718936272648 log_id String 文档ID src_ip String 源IP src_port Integer 源端口 dst_ip String 目的IP app String 规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。 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 源地域名称 dst_province_id String 目的省份id dst_province_name String 目的省份名称 dst_city_id String 目的城市id dst_city_name String 目的城市名称 src_province_id String 源省份id src_province_name String 源省份名称 src_city_id String 源城市id src_city_name String 源城市名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 查询项目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

响应示例 状态码： 200 查询流日志返回值 { "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, "src_province_id" : "source province id", "src_province_name" : "source province name", "src_city_id" : "source city id", "src_city_name" : "source city name", "dst_province_id" : "dst province id", "dst_province_name" : "dst province name", "dst_city_id" : "dst city id", "dst_city_name" : "dst city name" } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00500002", "error_msg" : "时间间距错误" }

URI GET /v1/{project_id}/cfw/logs/flow 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取 direction 否 String 方向，包含in2out，out2in log_type 否 String 日志类型包括：internet，vpc，nat start_time 是 Long 开始时间，以毫秒为单位的时间戳，如1718936272648 end_time 是 Long 结束时间，以毫秒为单位的时间戳，如1718936272648 src_ip 否 String 源IP src_port 否 Integer 源端口 dst_ip 否 String 目的IP dst_port 否 Integer 目的端口 protocol 否 String 协议类型，包含TCP, UDP,ICMP,ICMPV6等。 app 否 String 规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。 log_id 否 String 文档ID,第一页为空，其他页不为空，其他页可取上一次查询最后一条数据的log_id next_date 否 Long 下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的start_time offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空 limit 是 Integer 每页显示个数，范围为1-1024 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 dst_host 否 String 目的主机 src_region_name 否 String 源region名称 dst_region_name 否 String 目的region名称 src_province_name 否 String 源省份名称 dst_province_name 否 String 目的省份名称 src_city_name 否 String 源城市名称 dst_city_name 否 String 目的城市名称

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data UpdateAddressSetResponseData object 更新地址组返回数据 表6 UpdateAddressSetResponseData 参数 参数类型 描述 id String 地址组id name String 地址组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 将项目id为9d80d070b6d44942af73c9c3d38e0429下的地址组（id为cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16）的名称改为ABCD。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 { "name" : "ABCD", "description" : "" }

URI PUT /v1/{project_id}/address-sets/{set_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 set_id 是 String 地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

响应示例 状态码： 200 查询域名组列表返回值 { "data" : { "limit" : 50, "offset" : 0, "records" : [ { "config_status" : 3, "description" : "", "domain_set_type" : 0, "name" : "ccdd", "ref_count" : 0, "rules" : [ ], "set_id" : "e43db369-a863-45ed-8850-58d6b571b1ab" } ], "total" : 1 } }

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429下的防火墙 id为546af3f8-88e9-47f2-a205-2346d7090925下的域名组列表，防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data ListDomainsetsResponseData object 查询域名组列表返回值数据 表5 ListDomainsetsResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 total Integer 域名组总数 records Array of DomainSetVo objects 域名组列表 表6 DomainSetVo 参数 参数类型 描述 set_id String 域名组id name String 域名组名称 description String 域名组描述 ref_count Integer 域名组被规则引用次数 domain_set_type Integer 域名组类型，0表示应用域名组，1表示网络域名组 config_status Integer 配置状态，-1表示未配置态，0表示配置失败，1表示配置成功，2表示配置中，3表示正常，4表示配置异常 rules Array of UseRuleVO objects 使用规则id列表 表7 UseRuleVO 参数 参数类型 描述 id String 规则id name String 规则名称