云防火墙 CFW-华为云

云防火墙 CFW-查询防护规则:请求示例

请求示例查询项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象id为e12bd2cd-ebfc-4af7-ad6f-ebe6da398029的第一页，limit为10的数据示例URL https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0

云防火墙 CFW

云防火墙 CFW-查询防护规则:响应示例

响应示例状态码： 200 查询规则列表返回值 { "data" : { "limit" : 10, "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "offset" : 0, "records" : [ { "action_type" : 0, "address_type" : 0, "destination" : { "address" : "0.0.0.0/0", "address_type" : 0, "type" : 0 }, "direction" : 1, "long_connect_enable" : 0, "created_date" : "2024-02-27 04:01:17", "last_open_time" : "2024-02-27 04:01:17", "description" : "description", "name" : "eip_ipv4_n_w_allow", "rule_id" : "ffe9af47-d893-483b-86e3-ee5242e8cb15", "service" : { "dest_port" : "0", "protocol" : -1, "source_port" : "0", "type" : 0 }, "source" : { "address_set_id" : "48bfb09b-6f3a-4371-8ddb-05d5d7148bcc", "address_set_name" : "ip_group", "address_type" : 0, "type" : 1 }, "status" : 1, "type" : "0" } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

云防火墙 CFW

云防火墙 CFW-查询防护规则:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 data data object 查询规则列表返回值数据表5 data 参数参数类型描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 查询规则列表总条数 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 records Array of records objects 查询规则列表记录表6 records 参数参数类型描述 rule_id String 规则id address_type Integer 地址类型0 ipv4，1 ipv6 name String 规则名称 direction Integer 规则方向0：外到内1：内到外 action_type Integer 动作0：permit，1：deny status Integer 规则下发状态 0：禁用，1：启用 description String 描述 long_connect_time Long 长连接时长 long_connect_enable Integer 长连接支持 long_connect_time_hour Long 长连接时长对应小时 long_connect_time_minute Long 长连接时长对应分钟 long_connect_time_second Long 长连接时长秒 source RuleAddressDtoForResponse object 源地址对象 destination RuleAddressDtoForResponse object 目的地址对象 service RuleServiceDtoForResponse object 服务对象 type Integer 规则类型，0：互联网规则，1：vpc规则，2：nat规则 created_date String 规则创建时间，例如："2024-08-12 08:40:00" last_open_time String 规则最后开启时间，例如："2024-08-12 08:40:00" tag TagsVO object 规则附带标签对象表7 RuleAddressDtoForResponse 参数参数类型描述 type Integer 地址类型0手工输入，1关联IP地址组，2 域名，3地理位置，4域名组，5多对象，6域名组-DNS解析，7域名组-应用型。 address_type Integer 地址类型0 ipv4，1 ipv6，当type为0手动输入类型时不能为空 address String IP地址信息 address_set_id String 关联IP地址组ID address_set_name String 地址组名称 domain_address_name String 域名地址名称 region_list_json String 规则地域列表json值 region_list Array of IpRegionDto objects 规则地域列表 domain_set_id String 域名组id domain_set_name String 域名组名称 ip_address Array of strings IP地址列表 address_group Array of strings 地址组id列表 address_group_names Array of AddressGroupVO objects 地址组名称列表 address_set_type Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组表8 IpRegionDto 参数参数类型描述 region_id String 区域id，可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。 description_cn String 区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取。 description_en String 区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。 region_type Integer 区域类型，0表示国家，1表示省份，2表示大洲，可通过地域信息表获取。表9 AddressGroupVO 参数参数类型描述 address_set_type Integer 地址组类型，0表示自定义地址组，1表示WAF回源IP地址组，2表示DDoS回源IP地址组，3表示NAT64转换地址组 name String 关联IP地址组名称，可通过查询地址组列表接口查询获得，通过返回值中的data.records.name（.表示各对象之间层级的区分）获得。 set_id String 关联IP地址组ID，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。表10 RuleServiceDtoForResponse 参数参数类型描述 type Integer 服务输入类型，0为手动输入类型，1为自动输入类型 protocol Integer 协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,手动类型不为空，自动类型为空 protocols Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,手动类型不为空，自动类型为空 source_port String 源端口 dest_port String 目的端口 service_set_id String 服务组id service_set_name String 服务组名称 custom_service Array of ServiceItem objects 自定义服务 service_group Array of strings 服务组id列表 service_group_names Array of ServiceGroupVO objects 服务组名称列表 service_set_type Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库表11 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 服务成员名称表12 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（.表示各对象之间层级的区分）获得。表13 TagsVO 参数参数类型描述 tag_id String 规则id tag_key String 规则标签键 tag_value String 规则标签值状态码： 400 表14 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

云防火墙 CFW

云防火墙 CFW-查询防护规则:URI

URI GET /v1/{project_id}/acl-rules 表1 路径参数参数是否必选参数类型描述 project_id 是 String 租户项目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（.表示各对象之间层级的区分）获得 type 否 Integer 规则类型，0：互联网规则，1：vpc规则，2：nat规则 ip 否 String ip地址 name 否 String 规则名称 direction 否 Integer 方向0：外到内1：内到外 status 否 Integer 规则下发状态 0：禁用，1：启用 action_type 否 Integer 动作0：permit，1：deny address_type 否 Integer 地址类型，0表示ipv4，1表示ipv6 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取 tags_id 否 String 规则标签id，创建规则时产生。 source 否 String 源地址 destination 否 String 目的地址 service 否 String 服务端口 application 否 String 规则应用类型包括：“HTTP”，"HTTPS"，"TLS1"，“DNS”，“SSH”，“MYSQL”，“SMTP”，“RDP”，“RDPS”，“VNC”，“POP3”，“IMAP4”，“SMTPS”，“POP3S”，“FTPS”，“ANY”,“BGP”等。

云防火墙 CFW

云防火墙 CFW-删除地址组:URI

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

云防火墙 CFW

云防火墙 CFW-删除地址组:响应参数

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

云防火墙 CFW

云防火墙 CFW-删除地址组:响应示例

响应示例状态码： 200 删除地址组返回值 { "data" : { "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16", "name" : "test" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200004", "error_msg" : "所删除资源被引用，删除失败" }

云防火墙 CFW

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

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

云防火墙 CFW 地址组管理

云防火墙 CFW-查询地址组成员:请求示例

请求示例查询项目id为9d80d070b6d44942af73c9c3d38e0429的项目的地址组id为8773c082-2a6c-4529-939a-edc28ef1a67c的地址组成员信息 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?set_id=8773c082-2a6c-4529-939a-edc28ef1a67c&limit=10&offset=0

云防火墙 CFW 地址组管理

云防火墙 CFW-查询地址组成员:URI

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表示预定义地址组

云防火墙 CFW 地址组管理

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

响应示例状态码： 200 查询地址组成员返回值 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "address" : "1.1.1.1", "address_type" : 0, "description" : "", "item_id" : "294fab71-34bf-4858-a380-8f7530e1c816" } ], "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }

云防火墙 CFW 地址组管理

云防火墙 CFW-查询抓包任务:请求示例

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

云防火墙 CFW

云防火墙 CFW-查询抓包任务:响应示例

响应示例状态码： 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 } }

云防火墙 CFW

云防火墙 CFW-查询抓包任务:响应参数

响应参数状态码： 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

云防火墙 CFW

云防火墙 CFW-查询抓包任务:URI

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

云防火墙 CFW

云服务器内容精选

云防火墙 CFW

7*24

备案

专业服务

退订

建议反馈

售前咨询热线