华为云用户手册

URI GET /v1/{project_id}/vpcs/protection 表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为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data VPCProtectsVo object 防护vpc返回值 表5 VPCProtectsVo 参数 参数类型 描述 total Integer 总防护VPC数 self_total Integer 防火墙东西向防护可进行跨账号防护VPC，self_total表示本项目防护VPC总数。 other_total Integer 防火墙东西向防护可进行跨账号防护VPC，other_total表示其他项目防护VPC数 protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，protect_vpcs指的是总体防护VPC列表 self_protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，self_protect_vpcs指的是本项目防护VPC列表 other_protect_vpcs Array of VpcAttachmentDetail objects 防火墙东西向防护可进行跨账号防护VPC，other_protect_vpcs指的是其他项目防护VPC列表 total_assets Integer 租户的所有VPC资产数量 表6 VpcAttachmentDetail 参数 参数类型 描述 vpc_id String 东西向防护添加的防护vpc的id 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 destination 是 CaptureRuleAddressDto object 抓包规则目的地址请求体 duration 是 Integer 抓包时长，以分钟为单位 max_packets 是 Integer 最大抓包数，以个为单位 name 是 String 抓包任务名称 service 是 CaptureServiceDto object 抓包任务服务请求体 source 是 CaptureRuleAddressDto object 抓包规则源地址请求体 表5 CaptureServiceDto 参数 是否必选 参数类型 描述 dest_port 否 String 目的端口 protocol 是 Integer 协议类型:TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1，手动类型不为空，自动类型为空 source_port 否 String 源端口 表6 CaptureRuleAddressDto 参数 是否必选 参数类型 描述 address 是 String 地址 address_type 是 Integer 目的地址类型0 ipv4，1 ipv6 type 是 Integer 输入地址类型，目前只支持0，手工输入类型

请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c，防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4添加抓包任务，任务名称为zhuabaotest，最大抓包数为100000，抓包时长为3分钟，剩余保留天数为7天，源地址协议为tcp协议，地址类型为ipv4，地址为1.1.1.1，端口号为1-65535，目的地址协议为tcp协议，地址类型为ipv4，地址为2.2.2.2，端口号为1-65535。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default { "name" : "zhuabaotest", "max_packets" : 100000, "duration" : 3, "source" : { "type" : 0, "address_type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address_type" : 0, "address" : "2.2.2.2" }, "service" : { "protocol" : -1, "source_port" : "", "dest_port" : "" } }

URI POST /v1/{project_id}/capture-task 表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为14181c1245cf4fd786824efe1e2b9388的防火墙id为546af3f8-88e9-47f2-a205-2346d7090925的已有acl标签。 https://{Endpoint}/v2/14181c1245cf4fd786824efe1e2b9388/cfw-acl/tags?limit=1000&offset=0&fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

响应示例 状态码： 200 查询规则标签返回值 { "data" : { "limit" : 1000, "offset" : 0, "records" : [ { "tag_id" : "98fdf013-e7ad-4581-9c71-6de04c76a18f", "tag_key" : "1", "tag_value" : "1" }, { "tag_id" : "36e6fbfe-7fcd-48be-872b-4f6074e1e4e8", "tag_key" : "1", "tag_value" : "2" }, { "tag_id" : "0bf41046-6587-42f2-8399-a6864022b504", "tag_key" : "测试", "tag_value" : "测试" } ], "total" : 3 } }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data HttpGetAclTagResponseData object 获取规则标签数据 表5 HttpGetAclTagResponseData 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 规则标签总数 records Array of TagsVO objects 规则标签列表 表6 TagsVO 参数 参数类型 描述 tag_key String 规则标签键 tag_value String 规则标签值

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 X-Language 否 String 语言头部，默认为zh-cn，如需使用英文，请选择en-us 表4 请求Body参数 参数 是否必选 参数类型 描述 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（.表示各对象之间层级的区分）获得。 ips_type 是 Integer 补丁类型，仅支持虚拟补丁，值为2。 status 是 Integer ips特性开关状态，0表示关闭，1表示开启

请求示例 ips开关接口，该接口是租户界面通过开关控制引擎的基础补丁和虚拟补丁的开闭状态。以下示例为开启项目id为14181c1245cf4fd786824efe1e2b9388，防护对象id为1530de8a-522d-4771-9067-9fa4e2f53b48的基础补丁开关。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default { "ips_type" : 1, "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", "status" : 1 }

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

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获取方式获取

响应示例 状态码： 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 错误描述

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

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获取方式获取

请求示例 获取项目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 未开启防护 er_associated_subnet SubnetInfo object ER关联子网信息 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名称 state String ER状态,可以是pending,available,modifying,deleting,failed enterprise_project_id String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 project_id String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 enable_ipv6 String 是否开启ipv6，true表示是，false表示不是 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”等。 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”等。 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时生效

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