华为云用户手册

响应参数 状态码： 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 name String 地址组成员name description String 描述 address_type Integer 地址组类型，0 ipv4,1 ipv6 address String 地址信息 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/address-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 address 否 String ip地址 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 query_address_set_type 否 Integer 查询地址组类型，0表示自定义地址组，1表示预定义地址组

请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c，防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4查询50条抓包任务。 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default&limit=50&offset=0

响应示例 状态码： 200 查询抓包任务列表返回值 { "data" : { "limit" : 50, "offset" : 0, "records" : [ { "capture_size" : "--", "created_date" : "2024/06/04 11:23:50", "dest_address" : "2.2.2.2", "dest_address_type" : 0, "dest_port" : "", "duration" : 3, "is_deleted" : 0, "max_packets" : 100000, "modified_date" : "2024/06/04 11:23:50", "name" : "zhuabaotest", "protocol" : -1, "remaining_days" : 7, "source_address" : "1.1.1.1", "source_address_type" : 0, "source_port" : "", "status" : 2, "task_id" : "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" } ], "total" : 1 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data HttpQueryCaptureTaskResponseData object 查询抓包任务返回值数据 表5 HttpQueryCaptureTaskResponseData 参数 参数类型 描述 limit Integer 每页显示个数，范围为1-1024 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 total Long 抓包任务总数 records Array of CaptureTaskVO objects 抓包任务列表 表6 CaptureTaskVO 参数 参数类型 描述 capture_size String 抓包大小,如500kb,500mb created_date String 抓包创建时间,如2024/08/31 10:17:30 dest_address String 目的地址 dest_address_type Integer 目的地址类型0 ipv4，1 ipv6 dest_port String 目的端口 duration Integer 抓包时长，以分钟为单位 is_deleted Integer 是否被删除，0否 1是 max_packets Integer 最大抓包数，以个为单位 modified_date String 修改日期,如2024/08/31 10:17:30 name String 抓包任务名称 protocol Integer 协议类型:TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1，手动类型不为空，自动类型为空 remaining_days Integer 剩余保留天数 source_address String 源地址 source_address_type Integer 源地址类型0 ipv4，1 ipv6 source_port String 源端口 status Integer 抓包任务状态，如成功（1），运行中（2），已截止（4），截止中（5） task_id String 抓包任务id

URI GET /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获取方式获取 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data IpsProtectModeObject object 查询ips防护模式返回值数据 表5 IpsProtectModeObject 参数 参数类型 描述 id String ips防护模式id，此处为防护对象id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得 mode Integer ips防护模式，0：观察模式，1：严格模式，2：中等模式，3：宽松模式 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

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

请求示例 查询项目id为9d80d070b6d44942af73c9c3d38e0429的ips防护模式。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/ips/protect?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 查询访问控制日志返回数据 表5 data 参数 参数类型 描述 total Integer 查询访问控制日志记录总数 limit Integer 每页显示个数，范围为1-1024 records Array of records objects 查询访问控制日志记录 表6 records 参数 参数类型 描述 action String 动作0：permit，1：deny rule_name String 规则名称 rule_id String 规则id hit_time Long 命中时间，以毫秒为单位的时间戳，如1718936272648 src_region_id String 源区域id src_region_name String 源区域name dst_region_id String 目的区域id dst_region_name String 目的区域name log_id String 文档ID src_ip String 源IP src_port Integer 源端口 dst_ip String 目的IP dst_port Integer 目的端口 protocol String 协议类型:TCP为6,UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 app String 规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”，“BGP”等。 dst_host 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 目的城市名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询访问控制日志返回值 { "data" : { "limit" : 10, "records" : [ { "action" : "deny", "app" : "PING", "dst_ip" : "100.85.216.211", "dst_port" : 59, "hit_time" : 1664164255000, "log_id" : "46032", "protocol" : "ICMP: ECHO_REQUEST", "rule_id" : "c755be1c-4b92-4ae7-a15e-c2d02b152538", "rule_name" : "eip_ipv4_w_n_default_deny", "src_ip" : "100.95.148.49", "src_port" : 24954, "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" : "时间间距错误" }

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

URI GET /v1/{project_id}/cfw/logs/access-control 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙id，可通过防火墙ID获取方式获取 rule_id 否 String 规则id，可通过查询防护规则接口查询获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。 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 否 Integer 下个日期，当是第一页时为空，不是第一页时不为空，其他页可取上一次查询最后一条数据的start_time offset 否 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于0，首页时为空，非首页时不为空 limit 是 Integer 每页显示个数，范围为1-1024 log_type 否 String 日志类型包括：internet，vpc，nat enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 dst_host 否 String 目标主机 rule_name 否 String 规则名称 action 否 String 动作包含permit，deny 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 添加acl响应 { "data" : { "rules" : [ { "id" : "0475c516-0e41-4caf-990b-0c504eebd73f", "name" : "testName" } ] } } 状态码： 400 Bad Request { "error_code" : "CFW.00900016", "error_msg" : "导入任务进行中，请任务结束后再操作" }

响应参数 状态码： 200 表13 响应Body参数 参数 参数类型 描述 data RuleIdList object 创建规则返回值data数据 表14 RuleIdList 参数 参数类型 描述 rules Array of RuleId objects 规则id列表 表15 RuleId 参数 参数类型 描述 id String 规则id name String 规则名称 状态码： 400 表16 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 示例为添加一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule { "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "rules" : [ { "name" : "测试规则", "status" : 1, "action_type" : 0, "description" : "", "source" : { "type" : 0, "address" : "1.1.1.1" }, "destination" : { "type" : 0, "address" : "2.2.2.2" }, "service" : { "type" : 0, "protocol" : 6, "source_port" : "0", "dest_port" : "0" }, "address_type" : 0, "tag" : { "tag_key" : "", "tag_value" : "" }, "long_connect_enable" : 0, "direction" : 0, "sequence" : { "top" : 1, "dest_rule_id" : null } } ], "type" : 0 }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 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（.表示各对象之间层级的区分）获得 type 是 Integer 规则类型，0：互联网边界规则，1：vpc间规则，2：nat规则，当type取0时，规则源和目的地址需要为公网ip或 域名 ，vpc间规则需要源和目的地址为私有ip，nat规则需要源地址为私网ip，目的地址为公网ip或域名。 rules 是 Array of rules objects 添加规则请求规则列表 表5 rules 参数 是否必选 参数类型 描述 name 是 String 规则名称 sequence 是 OrderRuleAclDto object 修改规则顺序请求体 address_type 是 Integer 地址类型，0表示ipv4，1表示ipv6 action_type 是 Integer 规则动作，0表示允许通行（permit），1表示拒绝通行（deny） status 是 Integer 规则启用状态，0表示禁用，1表示启用 applications 否 Array of strings 规则应用列表，规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”，“BGP”等。 long_connect_time 否 Long 长连接时长 long_connect_time_hour 否 Long 长连接时长对应小时 long_connect_time_minute 否 Long 长连接时长对应分钟 long_connect_time_second 否 Long 长连接时长秒 long_connect_enable 是 Integer 是否支持长连接，0表示不支持长连接，1表示支持长连接 description 否 String 描述 direction 否 Integer 方向：0表示外到内，1表示内到外，规则type=0（互联网规则）或者type= 2（nat规则）时方向值必填 source 是 RuleAddressDtoForRequest object 源地址传输对象 destination 是 RuleAddressDtoForRequest object 目的地址传输对象 service 是 RuleServiceDto object 服务对象 tag 否 TagsVO object 规则附带标签对象 表6 OrderRuleAclDto 参数 是否必选 参数类型 描述 dest_rule_id 否 String 目标规则id，添加规则位于此规则之后，非置顶时不能为空，置顶时为空，目标规则id可以通过查询防护规则接口获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。 top 否 Integer 是否置顶，0代表非置顶，1代表置顶 bottom 否 Integer 是否置底，0代表非置底，1代表置底 表7 RuleAddressDtoForRequest 参数 是否必选 参数类型 描述 type 是 Integer 输入类型0手工输入，1关联IP地址组，2域名，3地理位置，4域名组，5多对象，6域名组-网络型，7域名组-应用型。 address_type 否 Integer 地址类型0 ipv4，1 ipv6，当type为0手动输入类型时不能为空 address 否 String IP地址信息，当type为0手动输入类型时不能为空 address_set_id 否 String 关联IP地址组ID，当type为1关联IP地址组类型时不能为空，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 address_set_name 否 String 关联IP地址组名称，当type为1关联IP地址组类型时不能为空，可通过查询地址组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 domain_address_name 否 String type为2（域名）和7（应用域名组）具体内容根据type中7修改后的类型名称 region_list_json 否 String 规则地域列表json值 region_list 否 Array of IpRegionDto objects 规则地域列表 domain_set_id 否 String 域名组id，type为4（域名组）或7（域名组-应用型）时不能为空。可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 domain_set_name 否 String 域名组名称，type为4（域名组）或7（域名组-应用型）时不能为空。可通过查询域名组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 ip_address 否 Array of strings IP地址列表，当type为5（多对象）时不能为空。 address_set_type 否 Integer 地址组类型，当type为1（关联IP地址组）时不能为空。0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 predefined_group 否 Array of strings 预定义地址组id列表，当type为5（多对象）时不能为空。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为1预定义地址组。 address_group 否 Array of strings 地址组id列表，当type为5（多对象）时不能为空。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为0自定义地址组。 表8 IpRegionDto 参数 是否必选 参数类型 描述 region_id 否 String 区域id，可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。 description_cn 否 String 区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取。 description_en 否 String 区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。 region_type 否 Integer 区域类型，0表示国家，1表示省份，2表示大洲，可通过地域信息表获取。 表9 RuleServiceDto 参数 是否必选 参数类型 描述 type 是 Integer 服务输入类型，0为手动输入类型，1为自动输入类型 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。 protocols 否 Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。 source_port 否 String 源端口 dest_port 否 String 目的端口 service_set_id 否 String 服务组id，当type为1（关联IP地址组）时不能为空，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 service_set_name 否 String 服务组名称,当type为1（关联IP地址组）时不能为空，可通过获取服务组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 custom_service 否 Array of ServiceItem objects 自定义服务 predefined_group 否 Array of strings 预定义服务组id列表，服务组id可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_service_set_type需要设置为1预定义服务组。 service_group 否 Array of strings 服务组id列表，服务组id可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_service_set_type需要设置为0自定义服务组。 service_group_names 否 Array of ServiceGroupVO objects 服务组名称列表 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 表10 ServiceItem 参数 是否必选 参数类型 描述 protocol 否 Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,RuleServiceDto.type为0时不能为空。 source_port 否 String 源端口 dest_port 否 String 目的端口 description 否 String 服务成员描述 name 否 String 服务成员名称 表11 ServiceGroupVO 参数 是否必选 参数类型 描述 name 否 String 服务组名称 protocols 否 Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1 service_set_type 否 Integer 服务组类型，0表示自定义服务组，1表示预定义服务组 set_id 否 String 服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 表12 TagsVO 参数 是否必选 参数类型 描述 tag_id 否 String 规则id tag_key 否 String 规则标签键 tag_value 否 String 规则标签值

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data CreateEWFirewallResp object 创建东西向防火墙返回值 表6 CreateEWFirewallResp 参数 参数类型 描述 id String 东西向防护id，对应object_id字段 er ER object ER信息 inspertion_vpc CreateEWFirewallInspectVpcResp object 引流vpc信息 表7 ER 参数 参数类型 描述 er_id String ER ID，创建东西向防护引用的 ID er_attach_id String 企业路由器连接id，该连接用于连接防火墙和企业路由器，此字段可在通过id在ER界面查询指定er后在管理连接界面查询连接了解连接具体情况。 表8 CreateEWFirewallInspectVpcResp 参数 参数类型 描述 vpc_id String 引流VPC的ID subnet_ids Array of strings 创建的引流VPC的子网ID列表

请求示例 项目09bb24e6f280d23d0f9fc0104b901480下防火墙55b26ab5-e4b0-40e8-941c-a1778fe2a500创建er模式防火墙inspection_cidr为10.1.0.0/24，er_id为e0b22a23-02cf-4092-ace9-34b39e10dc77。 https://{Endpoint}/v1/09bb24e6f280d23d0f9fc0104b901480/firewall/east-west?fw_instance_id=55b26ab5-e4b0-40e8-941c-a1778fe2a500&enterprise_project_id=default { "inspection_cidr" : "10.1.0.0/24", "mode" : "er", "er_id" : "e0b22a23-02cf-4092-ace9-34b39e10dc77" }

响应示例 状态码： 200 创建东西向防火墙返回值 { "data" : { "id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651", "er" : { "er_id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", "er_attach_id" : "bd62ddd3-5e20-482b-aefa-9e2940e2b1a9" }, "inspertion_vpc" : { "vpc_id" : "00672633-0466-4c35-99ef-5e3f5c813a4b", "subnet_ids" : [ "294682a0-1e85-45f5-92c8-e52bee09c204", "a86277bb-35d5-4442-bc0b-2e9d4e6a9080", "95829240-14e0-47e6-b9e7-2ac228e7b00f" ] } } }

URI POST /v1/{project_id}/firewall/east-west 表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参数 参数 是否必选 参数类型 描述 er_id 是 String 出方向关联ER ID,可通过ER服务查询企业路由器列表接口获得，返回值中instances.id即为erid（.表示各对象之间层级的区分） inspection_cidr 是 String 创建引流VPC时使用的网段 mode 是 String 东西向防火墙模式，填写er

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

请求示例 向项目id为09bb24e6fe80d23d2fa2c010b53b418c，防火墙id为ebf891cd-2163-48a0-9963-6309f99dd3c4删除抓包任务，抓包任务id为24e6bb6d-d335-48fd-b9c7-bbaaa851d209. https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/capture-task/batch-delete?fw_instance_id=ebf891cd-2163-48a0-9963-6309f99dd3c4&enterprise_project_id=default { "task_ids" : [ "24e6bb6d-d335-48fd-b9c7-bbaaa851d209" ] }

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

云联版本对应校验码 云联版本查看方法 右键点击已下载客户端安装包，点击属性 进入应用属性，点击详细信息 查看软件版本 云联版本校验码表 云联版本 校验码 7.0.5.195 ADD1FD75AB7117ACE60F9CD21DDAF7948D36AB18D6E5EDD1FE35DDFD9B6E29E3 7.0.4.61 C83C20217357DB03E8A2158E9019AB5307E7182AB64C92621307FDA1DFE4E609 父主题： 标准客户端hash值校验

请求示例 获取实况地址请求： POST /v2/123456789*****/devices/channels/media/live-connections { "expire_time":30, "use_times":0, "channels": [ { "channel_id": "0", "device_id": "219123456CYP***", "live_protocol":"HOLO", "stream_type": "SECONDARY_STREAM_1" }, { "channel_id": "1", "device_id": "219123456CYP***", "live_protocol":"HOLO", "stream_type": "PRIMARY_STREAM" } ] }

响应示例 状态码： 200 OK { "fail_num": 1, "live_connections": [ { "device_id": "219123456CYP***", "channel_id": "0", "cloud_trans_connections": {}, "p2p_connections": {}, "result": { "code": "IVM.10026004", "msg": "The param stream_type is not support." } }, { "device_id": "210123456SMY***", "channel_id": "0", "cloud_trans_connections": { "live_url": "jvmp://123.123.123.123:7070/live/210123456SMY***?token=content***" }, "p2p_connections": { "token": "content***", "device_state": "ONLINE", "p2p_nodes": [ { "node_type": "COMMON", "address_type": "IPV4", "address": [ "123.123.123.123" ], "tcp_port": 0, "udp_port": 7050 } ] }, "result": { "code": "IVM.0", "msg": "Success" } } ] }

响应参数 状态码： 200 表5 响应Body参数：播放P2P实况需要将响应Body参数中的所有内容输入到播放地址栏 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 live_connections Array of LiveConnectionResp objects 实况响应信息 表6 LiveConnectionResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] cloud_trans_connections CloudTransChannelsResp object 转发实况连接结构体 p2p_connections P2PChannelsResp object P2P实况连接结构体：仅支持HOLO媒体播放协议且请求设备为好望设备 result Result object 错误信息 表7 CloudTransChannelsResp 参数 参数类型 描述 live_url String 转发实况播放地址：将此url输入播放地址栏开始播放 表8 P2PChannelsResp 参数 参数类型 描述 token String P2P请求Token device_state String 在线状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 p2p_nodes Array of P2PMTSListResp objects P2P连接可用节点 表9 P2PMTSListResp 参数 参数类型 描述 node_type String 节点类型：枚举类型 枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高 address_type String 地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 address Array of strings 媒体转发服务地址： 协议头在SDK封装 ，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 tcp_port Integer TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留 udp_port Integer UDP端口：默认值为 7050 表10 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息