华为云用户手册

URI PUT /v1/{project_id}/acl-rule/{acl_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id acl_rule_id 是 String 规则Id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建 云防火墙 后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加ip地址为2.2.2.2，名称为ceshi的地址组成员 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items{ "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c", "address_items" : [ { "description" : "", "name" : "ceshi", "address" : "2.2.2.2" } ]}

URI POST /v1/{project_id}/address-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 set_id 否 String 地址组id address_items 否 Array of address_items objects 地址组成员信息 表5 address_items 参数 是否必选 参数类型 描述 name 是 String 地址名称 address_type 否 Integer 地址类型0 ipv4,1 ipv6 address 否 String 地址组ip信息 description 否 String 地址组成员描述

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 data AddressItems object 添加地址组成员返回数据 表7 AddressItems 参数 参数类型 描述 items Array of IdObject objects 地址组成员id列表 表8 IdObject 参数 参数类型 描述 id String id值 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data IdObject object 添加地址组返回数据 表6 IdObject 参数 参数类型 描述 id String id值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求示例 添加项目id为14181c1245cf4fd786824efe1e2b9388，防护对象 id为1530de8a-522d-4771-9067-9fa4e2f53b48，名称为ceshi的ipV4的地址组。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/address-set{ "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48", "name" : "ceshi", "description" : "", "address_type" : 0}

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 name 是 String 地址组名称 description 否 String 地址组描述 address_type 否 Integer 地址类型0 ipv4,1 ipv6 枚举值： 0 1

URI POST /v1/{project_id}/address-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

响应示例 状态码： 200 添加acl响应 { "data" : { "rules" : [ { "id" : "ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031" } ] }} 状态码： 400 Bad Request { "error_code" : "CFW.00900016", "error_msg" : "导入任务进行中，请任务结束后再操作"}

请求示例 示例为添加一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址类型为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule{ "object_id" : "e12bd2cd-ebfc-4af7-ad6f-ebe6da398029", "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, "long_connect_enable" : 0, "direction" : 0, "sequence" : { "top" : 1 } } ], "type" : 0}

URI POST /v1/{project_id}/acl-rule 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

响应参数 状态码： 200 表9 响应Body参数 参数 参数类型 描述 data RuleIdList object 规则id列表 表10 RuleIdList 参数 参数类型 描述 rules Array of RuleId objects 规则id列表 表11 RuleId 参数 参数类型 描述 id String id 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 type 是 Integer 规则type，0：互联网规则，1:vpc规则，2：nat规则 枚举值： 0 1 2 rules 是 Array of rules objects rules 表5 rules 参数 是否必选 参数类型 描述 name 是 String 规则名称 sequence 是 OrderRuleAclDto object 规则序列 address_type 是 Integer 地址类型，0 ipv4,1 ipv6,2 domain 枚举值： 0 1 2 action_type 是 Integer 动作0：permit,1：deny status 是 Integer 规则下发状态 0：禁用,1：启用 枚举值： 0 1 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表示支持长连接 枚举值： 0 1 description 否 String 描述 direction 否 Integer 方向：0表示外到内，1表示内到外 枚举值： 0 1 source 是 RuleAddressDto object 源地址传输对象 destination 是 RuleAddressDto object 目的地址传输对象 service 是 RuleServiceDto object 服务对象 表6 OrderRuleAclDto 参数 是否必选 参数类型 描述 dest_rule_id 否 String 目标规则id，添加规则位于此规则之后，非置顶时不能为空，置顶时为空 top 否 Integer 是否置顶，0代表非置顶，1代表置顶 表7 RuleAddressDto 参数 是否必选 参数类型 描述 type 是 Integer 源类型0手工输入,1关联IP地址组,2域名 address_type 否 Integer 源类型0 ipv4,1 ipv6 address 否 String 源IP，手动类型不能为空，自动及domain类型为空 address_set_id 否 String 关联IP地址组ID，自动类型不能为空，手动类型合domain类型为空 address_set_name 否 String 地址组名称 domain_address_name 否 String 域名地址名称，域名类型时不能为空，手动类型及自动类型时为空 表8 RuleServiceDto 参数 是否必选 参数类型 描述 type 是 Integer 服务输入类型，0为手动输入类型，1为自动输入类型 protocol 否 Integer 协议类型: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 服务组名称

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data IdObject object 添加黑白名单响应data 表6 IdObject 参数 参数类型 描述 id String id值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI POST /v1/{project_id}/black-white-list 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 list_type 是 Integer 黑白名单类型4：黑名单，5：白名单 direction 是 Integer 地址方向0：源地址1：目的地址 address_type 是 Integer Ip地址类型 0：ipv4,1:ipv6,2:domain address 是 String 地址类型 protocol 是 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 port 是 String 目的端口

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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 data ServiceItemIds object 新建服务组成员返回数据 表7 ServiceItemIds 参数 参数类型 描述 items Array of IdObject objects 服务组成员id列表 表8 IdObject 参数 参数类型 描述 id String id值 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 set_id 是 String 服务组id service_items 是 Array of service_items objects 添加服务组成员 表5 service_items 参数 是否必选 参数类型 描述 item_id 否 String 服务成员id protocol 是 Integer 协议类型:TCP为6, UDP为17,ICMP为1,ICMPV6为58,ANY为-1,手动类型不为空，自动类型为空 source_port 是 String 源端口 dest_port 是 String 目的端口 name 否 String 服务成员名称 description 否 String 服务成员描述

请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429的项目添加名称为ceshi的服务组成员，描述为添加服务组成员 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-items{ "set_id" : "7cdebed3-af07-494e-a3c2-b88bb8d58b57", "service_items" : [ { "description" : "添加服务组成员", "name" : "ceshi", "dest_port" : "1", "source_port" : "1", "protocol" : 6 } ]}

URI POST /v1/{project_id}/service-items 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 name 是 String 服务组名称 最小长度：1 最大长度：255 description 否 String 服务组描述信息 最小长度：1 最大长度：255

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data IdObject object 新建服务组返回数据 表6 IdObject 参数 参数类型 描述 id String id值 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI POST /v1/{project_id}/service-set 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求示例 添加项目id为9d80d070b6d44942af73c9c3d38e0429，防护对象为cfebd347-b655-4b84-b938-3c54317599b2，名称为ceshi的服务组。 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/service-set{ "object_id" : "cfebd347-b655-4b84-b938-3c54317599b2", "name" : "ceshi", "description" : ""}

URI POST /v1/{project_id}/firewall/east-west/protect 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得。具体可参考APIExlorer和帮助中心FAQ。默认情况下，fw_instance_Id为空时，返回帐号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。具体可参考APIExlorer和帮助中心FAQ。 status 是 Integer 防护状态：0 开启，1 关闭 枚举值： 0 1

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data data object 响应体 trace_id String trace id 表6 data 参数 参数类型 描述 id String 标识ID 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

请求示例 给项目id为09bb24e6fe80d23d2fa2c010b53b418c的项目的防护对象74820b38-1cc0-4f0b-8cce-32490fa840a3修改东西向防火墙防护状态为开启 https://{Endpoint}/v1/09bb24e6fe80d23d2fa2c010b53b418c/firewall/east-west/protect{ "object_id" : "74820b38-1cc0-4f0b-8cce-32490fa840a3", "status" : 1}