华为云用户手册

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data RuleId object 规则id列表 表6 RuleId 参数 参数类型 描述 id String id name String 名称 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/firewall/exist 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit 是 Integer 每页显示个数，范围为1-1024 service_type 是 Integer 服务类型 0 南北向防火墙 1 东西向防火墙 最小值：0 最大值：1 枚举值： 0 1 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 name 否 String 防火墙名称

响应示例 状态码： 200 获取存在防火墙实例响应 { "data" : { "limit" : 10, "offset" : 0, "records" : [ { "charge_mode" : 0, "engine_type" : 1, "enterprise_project_id" : "default", "feature_toggle" : { "is_support_anti_virus" : true, "is_support_application" : true, "is_support_tcp_proxy" : false, "is_support_url_profile" : true, "is_support_threat_tags" : true, "is_support_flow_associated_host" : false, "is_support_predefined" : true, "isSupportSession" : false, "is_support_acl_region_config" : true, "is_support_ips" : true, "is_support_ew_create_er_tenant_inspection_mode" : false, "ips_rule_list" : true, "long_connect" : true, "is_support_ew_create_vpc_peering_inspection_mode" : true, "alarm_config" : true, "is_not_support_resource_reduction" : false, "acl_multi_object" : true, "is_support_advanced_ips_rule" : true, "is_support_multi_account" : false, "is_support_capture" : true, "is_support_ew_create_er_bearer_inspection_mode" : true }, "flavor" : { "bandwidth" : 60, "eip_count" : 51, "log_storage" : 0, "session_concurrent" : 200, "session_create" : 200, "total_rule_count" : 200, "used_rule_count" : 2136, "version" : 1, "vpc_bandwith" : 1400, "vpc_count" : 8, "default_eip_count" : 20, "default_vpc_count" : 0, "default_bandwidth" : 10, "default_log_storage" : 0 }, "tags" : "{\"key1234\":\"1234\",\"key122\":\"2222\"}", "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "fw_instance_name" : "test", "ha_type" : 1, "is_available_obs" : false, "is_old_firewall_instance" : false, "is_support_threat_tags" : false, "name" : "1680054140516", "protect_objects" : [ { "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "object_name" : "1680054141674", "type" : 0 }, { "object_id" : "be83d202-df0b-498d-a96e-41589dc85c86", "object_name" : "ew-1680070626042", "type" : 1 } ], "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "resources" : [ { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "resource_spec_code" : "cfw.professional", "resource_type" : "hws.resource.type.cfw" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "0acdd5c7-1178-4bea-b5b6-bd55dc5e2669", "resource_size" : 5, "resource_size_measure_id" : 14, "resource_spec_code" : "cfw.expack.vpc.professional", "resource_type" : "hws.resource.type.cfw.exp.vpc" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "4002620c-916a-49c7-8042-cbe02fc17e61", "resource_size" : 5, "resource_size_measure_id" : 36, "resource_spec_code" : "cfw.expack.bandwidth.professional", "resource_type" : "hws.resource.type.cfw.exp.bandwidth" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "0235c7db-0baa-4c82-8db2-7b8d5108bd86", "resource_size" : 2, "resource_size_measure_id" : 14, "resource_spec_code" : "cfw.expack.eip.professional", "resource_type" : "hws.resource.type.cfw.exp.eip" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "079ade46-18cd-4917-b7bb-00d402931097", "resource_size" : 6, "resource_size_measure_id" : 14, "resource_spec_code" : "cfw.expack.vpc.professional", "resource_type" : "hws.resource.type.cfw.exp.vpc" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "dd078faa-abfd-4e63-b681-1a93489955b9", "resource_size" : 1, "resource_size_measure_id" : 14, "resource_spec_code" : "cfw.expack.eip.professional", "resource_type" : "hws.resource.type.cfw.exp.eip" }, { "cloud_service_type" : "hws.service.type.cfw", "resource_id" : "4d78d523-745d-4d54-a9ca-e6d25e555bde", "resource_size" : 10, "resource_size_measure_id" : 36, "resource_spec_code" : "cfw.expack.bandwidth.professional", "resource_type" : "hws.resource.type.cfw.exp.bandwidth" } ], "service_type" : 0, "status" : 2, "support_ipv6" : true, "support_url_filtering" : true } ], "total" : 1 } }

请求示例 更新项目id为408972e72dcd4c1a9b033e955802a36b的防火墙id为22c4a5db-504c-471f-8187-5192bc11de0b的防火墙的日志配置，lts日志配置为关闭，流日志、访问控制日志、攻击日志设置为关闭。 https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/cfw/logs/configuration?fw_instance_id=22c4a5db-504c-471f-8187-5192bc11de0b&enterprise_project_id=default { "fw_instance_id" : "22c4a5db-504c-471f-8187-5192bc11de0b", "lts_enable" : 0, "lts_log_group_id" : "20282428-a8f9-4e75-8246-165e64cf8ba8", "lts_attack_log_stream_enable" : 0, "lts_access_log_stream_enable" : 0, "lts_flow_log_stream_enable" : 0 }

URI PUT /v1/{project_id}/cfw/logs/configuration 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口。 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表4 请求Body参数 参数 是否必选 参数类型 描述 fw_instance_id 是 String 防火墙id lts_enable 是 Integer 是否开启LTS lts_log_group_id 是 String LTS日志分组id lts_attack_log_stream_id 否 String 攻击日志流id lts_attack_log_stream_enable 是 Integer 是否开启攻击日志流 lts_access_log_stream_id 否 String 访问控制日志流id lts_access_log_stream_enable 是 Integer 是否开启访问控制流 lts_flow_log_stream_id 否 String 流量日志id lts_flow_log_stream_enable 是 Integer 是否开启流量日志

响应示例 状态码： 200 OK { "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" : "实例状态错误" }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object data 表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 records 表6 records 参数 参数类型 描述 rule_id String 规则id address_type Integer 地址类型0 ipv4,1 ipv6 name String 规则名称 direction Integer 规则方向0：外到内1：内到外 枚举值： 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 destination service RuleServiceDtoForResponse object service type Integer 规则type，0：互联网规则，1：vpc规则，2：nat规则 枚举值： 0 1 2 created_date String 创建时间 last_open_time String 最后开启时间 tag TagsVO object 标签显示信息 表7 RuleAddressDtoForResponse 参数 参数类型 描述 type Integer 源类型0手工输入,1关联IP地址组,2域名，3地理位置，4域名组，5多对象，6域名组-DNS解析，7域名组-URL过滤。 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 域名地址名称，域名类型时不能为空，手动类型及自动类型时为空 region_list_json String 规则region列表json值 region_list Array of IpRegionDto objects 规则region列表 domain_set_id String 域名组id domain_set_name String 域名组名称 ip_address Array of strings IP地址列表 address_group Array of strings 地址组列表 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 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 地址组名称 set_id String 地址组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 服务组列表 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,手动类型不为空，自动类型为空 source_port String 源端口 dest_port String 目的端口 description String 服务成员描述 name String 服务成员名称 表12 ServiceGroupVO 参数 参数类型 描述 name String 服务组名称 protocols Array of integers 协议列表 service_set_type Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 set_id String 服务组ID 表13 TagsVO 参数 参数类型 描述 tag_id String 标签id tag_key String 标签键 tag_value String 标签值 状态码： 400 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/acl-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目id 表2 Query参数 参数 是否必选 参数类型 描述 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 type 否 Integer 规则Type0：互联网规则,1：vpc规则, 2:nat规则 枚举值： 0 1 2 ip 否 String ip地址 name 否 String 名称 direction 否 Integer 方向0：外到内1：内到外 status 否 Integer 规则下发状态 0：禁用,1：启用 枚举值： 0 1 action_type 否 Integer 动作0：permit,1：deny 枚举值： 0 1 address_type 否 Integer 地址类型0 ipv4 枚举值： 0 1 2 limit 是 Integer 每页显示个数，范围为1-1024 offset 是 Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 tags_id 否 String 标签id source 否 String 源地址 destination 否 String 目的地址 service 否 String 服务端口 application 否 String 应用

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 job_id String 实例创建的任务id。 仅创建按需实例时会返回该参数。 order_id String 订单号，创建包年包月时返回该参数。 data CreateFirewallReq object 按需防火墙实体 表8 CreateFirewallReq 参数 参数类型 描述 name String 防火墙名称 enterprise_project_id String 企业项目ID，租户未开启企业项目时传0 缺省值：0 tags Array of tags objects 资源标签 flavor flavor object 规格信息 charge_info charge_info object 计费类型信息，支持包年/包月和按需，默认为按需。 表9 tags 参数 参数类型 描述 key String 标签KEY value String 标签VALUE 表10 flavor 参数 参数类型 描述 version String 防火墙版本 “charge_mode”为“prePaid”时，仅支持专业版。 “charge_mode”为“postPaid”时，支持标准版、专业版。 Standard - 标准版 Professional - 专业版 枚举值： Standard Professional extend_eip_count Integer 扩展EIP数量，仅包周期场景下生效 最小值：0 最大值：2000 缺省值：0 extend_bandwidth Integer 扩展带宽，步长为5，仅包周期场景下生效 最小值：0 最大值：5000 extend_vpc_count Integer 扩展VPC数量，仅包周期场景下生效 最小值：0 最大值：100 表11 charge_info 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3。 is_auto_renew Boolean 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，为自动续订。 false，为不自动续订，默认该方式。 缺省值：false is_auto_pay Boolean 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付。（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券) false，为手动支付，默认该方式。（需要客户手动去支付，客户可以选择折扣和优惠券） 缺省值：false 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 执行成功，返回JobID { "data" : { "charge_info" : { "charge_mode" : "prePaid", "is_auto_pay" : true, "is_auto_renew" : true, "period_num" : 1, "period_type" : "month" }, "enterprise_project_id" : "0", "flavor" : { "extend_bandwidth" : 5000, "extend_eip_count" : 2000, "extend_vpc_count" : 100, "version" : "Standard" }, "name" : "CFW-TEST", "tags" : [ { "key" : "TagKey", "value" : "TagVal" } ] }, "order_id" : "CS2403271050ZEM0L" } 状态码： 400 请求体错误 { "error_code" : "CFW.00100001", "error_msg" : "系统繁忙，请稍后重试" }

请求示例 开通标准版防火墙，扩展防护EIP2000个，扩展防护带宽5000Mbps，扩展防护VCP100个，包周期计费模式，启用自动续费，启用自动付款，开通1个月 https://{Endpoint}/v2/124147da-5b08-471a-93d2-bc82acc290c6/firewall { "name" : "CFW-TEST", "enterprise_project_id" : "0", "tags" : [ { "key" : "TagKey", "value" : "TagVal" } ], "flavor" : { "version" : "standard", "extend_eip_count" : 2000, "extend_bandwidth" : 5000, "extend_vpc_count" : 100 }, "charge_info" : { "charge_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : true, "is_auto_pay" : true } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） X-Client-Token 否 String 保证客户端请求幂等性的标识。 该标识为32位UUID格式，由客户端生成，且需确保不同请求之间该标识具有唯一性。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 防火墙名称 enterprise_project_id 否 String 企业项目ID，租户未开启企业项目时传0 缺省值：0 tags 否 Array of tags objects 资源标签 flavor 是 flavor object 规格信息 charge_info 是 charge_info object 计费类型信息，支持包年/包月和按需，默认为按需。 表4 tags 参数 是否必选 参数类型 描述 key 否 String 标签KEY value 否 String 标签VALUE 表5 flavor 参数 是否必选 参数类型 描述 version 是 String 防火墙版本 “charge_mode”为“prePaid”时，仅支持专业版。 “charge_mode”为“postPaid”时，支持标准版、专业版。 Standard - 标准版 Professional - 专业版 枚举值： Standard Professional extend_eip_count 否 Integer 扩展EIP数量，仅包周期场景下生效 最小值：0 最大值：2000 缺省值：0 extend_bandwidth 否 Integer 扩展带宽，步长为5，仅包周期场景下生效 最小值：0 最大值：5000 extend_vpc_count 否 Integer 扩展VPC数量，仅包周期场景下生效 最小值：0 最大值：100 表6 charge_info 参数 是否必选 参数类型 描述 charge_mode 是 String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type 否 String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 period_num 否 Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： 当“period_type”为“month”时，取值为1~9。 当“period_type”为“year”时，取值为1~3。 is_auto_renew 是 Boolean 创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true，为自动续订。 false，为不自动续订，默认该方式。 缺省值：false is_auto_pay 是 Boolean 创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true，为自动支付。（会自动选择折扣和优惠券进行优惠，然后自动从客户华为云账户中支付），自动支付失败后会生成订单成功(该订单应付金额是优惠后金额)、但订单状态为“待支付”，等待客户手动支付(手动支付时，客户还可以修改系统自动选择的折扣和优惠券) false，为手动支付，默认该方式。（需要客户手动去支付，客户可以选择折扣和优惠券） 缺省值：false

请求参数 表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 地址组成员描述

请求示例 给项目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" } ] }

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

响应示例 状态码： 200 添加地址组成员返回值 { "data" : { "covered_ip" : [ ], "items" : [ { "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae" } ] } } 状态码： 400 Bad Request { "error_code" : "CFW.00200001", "error_msg" : "空参数错误" }

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，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data EipCountRespData object Eip个数数据 表5 EipCountRespData 参数 参数类型 描述 object_id String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 最小长度：36 最大长度：36 eip_total Integer EIP总数 最小值：0 缺省值：0 eip_protected Integer 该账号下所有墙防护EIP总数量 最小值：0 缺省值：0 eip_protected_self Integer 该当前防火墙防护EIP数量 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

URI GET /v1/{project_id}/eip-count/{object_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 最小长度：32 最大长度：32 object_id 是 String 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 最小长度：36 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目id，用户支持企业项目后，由企业项目生成的id。 fw_instance_id 否 String 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

响应示例 状态码： 200 OK { "data" : { "eip_protected" : 1, "eip_protected_self" : 4, "eip_total" : 5, "object_id" : "" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200005", "error_msg" : "操作内容不存在" }

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

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

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

响应示例 状态码： 200 添加服务组成员返回值 { "data" : { "items" : [ { "id" : "cc41c4af-86e8-4ed2-80ad-87d399aeaed0" } ] } } 状态码： 400 Bad Request { "error_code" : "CFW.00200001", "error_msg" : "空参数错误" }

请求示例 给项目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 } ] }

请求参数 表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 参数 是否必选 参数类型 描述 protocol 是 Integer 协议类型:TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1，手动类型不为空，自动类型为空 source_port 是 String 源端口 dest_port 是 String 目的端口 name 否 String 服务成员名称 description 否 String 服务成员描述

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，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。

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