华为云用户手册

响应示例 状态码： 200 查询黑白名单列表返回值 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "address" : "1.1.1.1", "address_type" : 0, "description" : "", "direction" : 0, "list_id" : "1310d401-daf5-44f2-8276-f79e1643984d", "protocol" : 6 } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2第一页的白名单，查询条数为5条 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/black-white-lists?object_id=cfebd347-b655-4b84-b938-3c54317599b2&limit=10&offset=0&list_type=5

响应参数 状态码： 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 参数 参数类型 描述 list_id String 黑白名单列表id direction Integer 黑白地址方向0：源地址1：目的地址 address_type Integer ip地址类型0：ipv4，1:ipv6 address String ip地址 protocol Integer 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 port String 端口 description String 描述 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/black-white-lists 表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（.表示各对象之间层级的区分）获得 list_type 是 Integer 黑白名单类型4：黑名单，5：白名单 address_type 否 Integer ip地址类型0：ipv4，1:ipv6 address 否 String ip地址 port 否 String 端口 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

URI PUT /v1/{project_id}/service-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 表5 响应Body参数 参数 参数类型 描述 data ServiceSetId object 更新服务组数据 表6 ServiceSetId 参数 参数类型 描述 id String 服务组Id name String 服务组名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 更新项目id为9d80d070b6d44942af73c9c3d38e0429的服务组id为221cfdca-3abf-4c30-ab0d-516a03c70866的名称改为ceshi2，描述改为描述 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-sets/221cfdca-3abf-4c30-ab0d-516a03c70866 { "name" : "ceshi2", "description" : "描述" }

请求示例 获取项目id为09bb24e6f280d23d0f9fc0104b901480下的防火墙id为80e0f2df-24fd-49c2-8398-11f9a0299b3e的东西向防火墙信息。 https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?limit=10&offset=0&fw_instance_id=80e0f2df-24fd-49c2-8398-11f9a0299b3e

响应示例 状态码： 200 东西向防火墙信息响应 { "data" : { "er" : { "id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", "name" : "er", "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "attachment_id" : "e978c028-0ccf-4168-a015-0094ac631e88" }, "inspection_vpc" : { "cidr" : "10.13.13.0/24", "id" : "3baa2248-03d4-47ac-aefa-ec6f9a30ed80", "name" : "inspection-vpc" }, "limit" : 50, "mode" : "er", "object_id" : "6cc31075-0b03-461d-aa3a-73c4765bf9ac", "offset" : 0, "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protect_infos" : [ { "protected_resource_id" : "09b26b83-4b7c-499f-805b-50820900cd9f", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-4", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "2956f917-af18-44a2-a0f2-f592633d4431", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t3", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "69d4c81f-80bd-4c28-9074-f26b400b3a34", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t2", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "e1b18d3e-8f7d-4c4e-a326-37db7bd89a3a", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-t1", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "f91c1747-1325-4b39-9d58-7fac0bd2786f", "protected_resource_mode" : "er", "protected_resource_name" : "vpc-5", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { "protected_resource_id" : "bd556a7d-447e-49eb-be17-f93af09769f5", "protected_resource_mode" : "er", "protected_resource_name" : "inspct-a", "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 1 } ], "status" : 0, "total" : 6 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data GetEastWestFirewallResponseBody object 获取东西向防火墙列表返回data 表5 GetEastWestFirewallResponseBody 参数 参数类型 描述 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 project_id String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 status Integer 防护状态：0 已开启防护， 1 未开启防护 firewall_associated_subnets Array of SubnetInfo objects 云防火墙关联子网信息 er ErInstance object 出方向关联企业路由器信息 inspection_vpc VpcDetail object 引流vpc信息 protect_infos Array of EwProtectResourceInfo objects 东西向防护资源信息 total Integer 防护VPC总数 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 mode String 防护模式，值为er 表6 SubnetInfo 参数 参数类型 描述 availability_zone String 子网所在的可用区标识，从终端节点获取，参考终端节点。 cidr String 功能说明：虚拟私有云下可用子网的范围 取值范围： 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 不指定cidr时，默认值为空 约束：必须是cidr格式，例如:192.168.0.0/16 name String 子网名称 id String 子网id gateway_ip String 子网的网关，取值范围为子网网段cidr中的ip地址 vpc_id String 创建vpc产生的uuid ipv6_enable Boolean 是否支持ipv6，boolean值为true表示是，false表示否 表7 ErInstance 参数 参数类型 描述 id String ER ID，创建ER时产生的ID name String ER名称 project_id String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 attachment_id String 企业路由器连接id，该连接用于连接防火墙和企业路由器，此字段可在通过id在ER界面查询指定er后在管理连接界面查询连接了解连接具体情况。 表8 VpcDetail 参数 参数类型 描述 id String 创建引流VPC产生的随机UUID name String 引流VPC名称 cidr String 功能说明：虚拟私有云下可用子网的范围 取值范围： 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 不指定cidr时，默认值为空 约束：必须是cidr格式，例如:192.168.0.0/16 表9 EwProtectResourceInfo 参数 参数类型 描述 protected_resource_type Integer 防护资源类型：0 VPC，1 VGW，2 VPN，3 PEERING protected_resource_name String 防护资源名称 protected_resource_id String 防护资源id protected_resource_nat_name String 防护资源nat网关名称，专业版防火墙支持NAT规则，此字段表示防护连接的NAT的名称。 protected_resource_nat_id String 防护资源nat网关id，专业版防火墙支持NAT规则，此字段表示防护连接的NAT的id。 protected_resource_project_id String 防火墙支持跨账户防护，此处为防护资源租户id protected_resource_mode String 防护资源模式，为er status Integer 防护资源的防护状态，0表示已关联，1表示未关联。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/firewall/east-west 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429防火墙id为2af58b7c-893c-4453-a984-bdd9b1bd6318初始时间为1663567058000，结束时间为1664171765000的第一页数据，查询条数为10条 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/cfw/logs/attack?fw_instance_id=2af58b7c-893c-4453-a984-bdd9b1bd6318&start_time=1663567058000&end_time=1664171765000&limit=10

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询攻击日志返回值数据 表5 data 参数 参数类型 描述 total Integer 返回攻击数据总数 limit Integer 每页显示个数，范围为1-1024 records Array of records objects 攻击日志记录列表 表6 records 参数 参数类型 描述 direction String 方向，包含in2out，out2in action String 动作包含permit，deny event_time Long 事件时间，以毫秒为单位的时间戳，如1718936272648 attack_type String 攻击类型 attack_rule String 攻击规则 level String 威胁等级，包括CRITICAL、HIGH、MEDIUM、LOW source String 来源 packet_length Long 报文长度 attack_rule_id String 攻击规则id hit_time Long 命中时间，以毫秒为单位的时间戳，如1718936272648 log_id String 日志ID src_ip String 源IP src_port Integer 源端口 dst_ip String 目的IP dst_port Integer 目的端口 protocol String 协议类型，包含TCP, UDP,ICMP,ICMPV6等。 packet String 攻击日志报文 app String 规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。 packetMessages Array of PacketMessage objects 攻击报文信息 src_region_id String 源区域id src_region_name String 源区 域名 称 dst_region_id String 目的区域id dst_region_name String 目的区域名称 src_province_id String 源省份id src_province_name String 源省份名称 src_city_id String 源城市id src_city_name String 源城市名称 dst_province_id String 目的省份id dst_province_name String 目的省份名称 dst_city_id String 目的城市id dst_city_name String 目的城市名称 表7 PacketMessage 参数 参数类型 描述 hex_index String 16进制index hexs Array of strings 16进制数列 utf8_String String utf_8字符串 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/cfw/logs/attack 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 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 下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的event_time offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空 limit 是 Integer 每页显示个数，范围为1-1024 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取 action 否 String 动作包含permit，deny direction 否 String 方向，包含in2out，out2in attack_type 否 String 入侵事件类型 attack_rule 否 String 入侵事件规则 level 否 String 威胁等级，包括CRITICAL、HIGH、MEDIUM、LOW enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 dst_host 否 String 目标主机 log_type 否 String 日志类型包括：internet，vpc，nat attack_rule_id 否 String 入侵事件id 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 目的城市名称

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429，服务组id为7cdebed3-af07-494e-a3c2-b88bb8d58b57的服务组成员列表 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items?set_id=7cdebed3-af07-494e-a3c2-b88bb8d58b57&limit=10&offset=0

响应示例 状态码： 200 服务组成员列表返回值 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "dest_port" : "0", "item_id" : "805b711d-c558-41e3-aab1-a4b8c3f1f90b", "description" : "", "protocol" : 1, "source_port" : "0" } ], "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57", "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 服务组成员列表 表5 data 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 服务组成员总数 set_id String 服务组id records Array of records objects 记录 表6 records 参数 参数类型 描述 item_id String 服务成员id protocol Integer 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 source_port String 源端口 dest_port String 目的端口 description String 服务成员描述 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 - String 状态码： 403 表9 响应Body参数 参数 参数类型 描述 - String 状态码： 404 表10 响应Body参数 参数 参数类型 描述 - String 状态码： 500 表11 响应Body参数 参数 参数类型 描述 - String

URI GET /v1/{project_id}/service-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 set_id 是 String 服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 key_word 否 String 查询字段，可为服务组成员名称或服务组成员描述的一部分。 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 query_service_set_type 否 Integer 查询服务组类型，0表示自定义服务组，1表示预定义服务组。仅当set_id为预定义服务组id时生效

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 user_support_eps Boolean 是否支持企业项目，true表示是，false表示不是 has_ndr Boolean 是否存在ndr，true表示是，false表示不是，NDR为原旁路版防火墙，现已停止售卖。 is_support_postpaid Boolean 是否支持按需购买，true表示是，false表示不是 is_support_basic_version Boolean 是否支持基础版，true表示是，false表示不是 is_support_buy_professional Boolean 是否支持购买专业版，true表示是，false表示不是 data HttpFirewallInstanceListResponseData object 查询防火墙列表返回值data信息 表7 HttpFirewallInstanceListResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 project_id String 租户项目ID total Integer 防火墙总数量 records Array of FirewallInstanceVO objects 查询防火墙列表记录 表8 FirewallInstanceVO 参数 参数类型 描述 fw_instance_id String 防火墙实例id，创建云防火墙后用于标记防火墙由系统自动生成的id。 resource_id String 资源id，与防火墙实例id fw_instance_id相同 name String 创建防火墙时的时间戳 fw_instance_name String 防火墙名称 enterprise_project_id String 企业项目id，用户支持企业项目后，由企业项目生成的id。 ha_type Integer 集群类型，包含主备（0）和集群（1）两种方式，主备模式包含四个节点，2个主节点构成集群，剩余两个节点为主节点的备节点，集群模式仅拉起两个节点作为集群。 charge_mode Integer 计费模式 0：包年/包月 1：按需 service_type Integer 防火墙防护类型，目前仅支持0，互联网防护。 engine_type Integer 引擎类型，0：自研引擎 1：山石引擎 3：天融信引擎 flavor Flavor object 防火墙规格信息 status Integer 防火墙状态列表，包括-1：等待支付，0：创建中，1：删除中，2：运行中，3：升级中，4：删除完成：5：冻结中，6：创建失败，7：删除失败，8：冻结失败，9：存储中，10：存储失败，11：升级失败 tags String 标签列表，标签键值map转化的json字符串，如"{"key":"value"}" 表9 Flavor 参数 参数类型 描述 version Integer 防火墙版本，0：标准版，1：专业版，3：基础版，购买时，当防火墙“charge_mode”为“postPaid”时，仅支持专业版。“charge_mode”为“prePaid”时，支持标准版、专业版。 eip_count Integer eip数量 vpc_count Integer vpc数量 bandwidth Integer 带宽，单位为mbps log_storage Integer 日志存储，单位为byte default_bandwidth Integer 默认防火墙带宽，单位为mbps，标准版为10，专业版为50，按需专业版为200 default_eip_count Integer 默认eip数，标准版为20，专业版为50，按需专业版为1000 default_log_storage Integer 默认日志存储，单位为byte，默认为0 default_vpc_count Integer 默认vpc数，标准版为0，专业版为2，按需专业版为5

请求示例 查询项目id为14181c1245cf4fd786824efe1e2b9388，企业项目id为all_granted_eps的第一页的防火墙列表 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/firewalls/list?enterprise_project_id=all_granted_eps { "limit" : 10, "offset" : 0 }

响应示例 状态码： 200 查询防火墙列表返回值 { "data" : { "limit" : 1, "offset" : 0, "project_id" : "14181c1245cf4fd786824efe1e2b9388", "records" : [ { "fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", "name" : "1709176078374", "fw_instance_name" : "test", "enterprise_project_id" : "default", "tags" : "{\"key_test3\":\"value_test3\"}", "ha_type" : 0, "charge_mode" : 0, "service_type" : 0, "engine_type" : 1, "flavor" : { "version" : 1, "eip_count" : 50, "vpc_count" : 6, "bandwidth" : 50, "log_storage" : 0, "default_eip_count" : 50, "default_vpc_count" : 2, "default_bandwidth" : 50, "default_log_storage" : 0 }, "status" : 2 } ], "total" : 18 }, "has_ndr" : false, "is_support_basic_version" : true, "is_support_buy_professional" : false, "is_support_postpaid" : true, "user_support_eps" : false }

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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 key_word 否 String 查询关键字，可为防火墙id或防火墙名称的一部分。可通过防火墙ID获取方式获取 tags 否 Array of TagInfo objects 标签列表，可通过查询标签服务查询标签接口获得，返回值即为标签列表 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 表5 TagInfo 参数 是否必选 参数类型 描述 key 否 String 标签键 values 否 Array of strings 标签值列表

URI DELETE /v1/{project_id}/acl-rule/count 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目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参数 参数 是否必选 参数类型 描述 rule_ids 是 Array of strings 删除规则击中次数请求的规则列表，规则id可通过查询防护规则接口查询获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。

请求示例 清除项目id为0b2179bbe180d3762fb0c01a2d5725c7中acl规则id为59ff6bd9-0a76-41ec-9650-380086069965的命中次数 https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/acl-rule/count { "rule_ids" : [ "59ff6bd9-0a76-41ec-9650-380086069965" ] }

请求示例 删除项目id为9d80d070b6d44942af73c9c3d38e0429下的地址组成员id为65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae的地址组成员 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items/65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data AddressItemId object 删除地址组成员id数据 表5 AddressItemId 参数 参数类型 描述 id String 地址组成员id name String 地址组成员名称 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

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