华为云用户手册

响应示例 状态码： 200 获取dns服务器响应 { "data" : [ { "health_check_domain_name" : "sslstatic.xiaoyusan.com", "id" : 20165, "is_applied" : 0, "is_customized" : 1, "server_ip" : "0.0.0.0" }, { "health_check_domain_name" : "sslstatic.xiaoyusan.com", "id" : 14190, "is_applied" : 1, "is_customized" : 0, "server_ip" : "100.79.1.240" } ], "total" : 2 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of DnsServersResponseDTO objects dns服务器列表 total Integer dns服务器总数 表5 DnsServersResponseDTO 参数 参数类型 描述 id Integer 域名 服务器id is_applied Integer 域名服务器是否应用，0否 1是 is_customized Integer 域名服务器是否是用户自定义的dns服务器，0否 1是 server_ip String DNS服务器IP health_check_domain_name String 健康检查域名

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

请求示例 示例为更新一个IPv4类型的外到内的规则，名称为测试规则，源类型为IP地址，地址为1.1.1.1，目的类型为IP地址，目的地址为2.2.2.2，服务类型为服务，协议类型为TCP，源端口为0，目的端口为0，不支持长连接，动作为放行，启用状态为启用 https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rule/ceaa0407-b9c8-4dfd-9eca-b6ead2dfd031 { "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" }, "type" : 0, "address_type" : 0, "tag" : { "tag_key" : "", "tag_value" : "" }, "long_connect_enable" : 0, "direction" : 0 }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表4 请求Body参数 参数 是否必选 参数类型 描述 address_type 否 Integer 地址类型，0表示ipv4，1表示ipv6 name 否 String 规则名称 direction 否 Integer 方向：0表示外到内，1表示内到外,规则type=0（互联网规则）或者type= 2（nat规则）时方向值必填 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”等。 description 否 String 规则描述 long_connect_time_hour 否 Long 长连接时长对应小时 long_connect_time_minute 否 Long 长连接时长对应分钟 long_connect_time_second 否 Long 长连接时长秒 long_connect_time 否 Long 长连接时长 long_connect_enable 否 Integer 是否支持长连接，0表示不支持，1表示支持 source 否 RuleAddressDto object 源地址传输对象 destination 否 RuleAddressDto object 目的地址传输对象 service 否 RuleServiceDto object 服务对象 type 否 Integer 规则类型，0：互联网规则，1：vpc规则，2：nat规则 tag 否 TagsVO object 规则附带标签对象 表5 RuleAddressDto 参数 是否必选 参数类型 描述 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_group 否 Array of strings 地址组id列表，当type为5（多对象）时不能为空。地址组id可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。查询条件中query_address_set_type需要设置为0自定义地址组。 address_group_names 否 Array of AddressGroupVO objects 地址组名称列表 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预定义地址组。 表6 IpRegionDto 参数 是否必选 参数类型 描述 region_id 否 String 区域id，可通过获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID获取。 description_cn 否 String 区域中文描述，仅当区域为中国区域时使用，可通过地域信息表获取。 description_en 否 String 区域英文描述，仅当区域为非中国区域时使用，可通过地域信息表获取。 region_type 否 Integer 区域类型，0表示国家，1表示省份，2表示大洲，可通过地域信息表获取。 表7 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（.表示各对象之间层级的区分）获得。 表8 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表示常用数据库 表9 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 服务成员名称 表10 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（.表示各对象之间层级的区分）获得。 表11 TagsVO 参数 是否必选 参数类型 描述 tag_id 否 String 规则id tag_key 否 String 规则标签键 tag_value 否 String 规则标签值

URI PUT /v1/{project_id}/acl-rule/{acl_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 acl_rule_id 是 String 规则id，可通过查询防护规则接口查询获得，通过返回值中的data.records.rule_id（.表示各对象之间层级的区分）获得。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 fw_instance_id 否 String 防火墙id，可通过防火墙ID获取方式获取

请求示例 查询项目id为2349ba469daf4b7daf268bb0261d18b0的项目的防护对象id为a37bb4eb-c49e-4e88-bf77-944a75b0ce8a的第一页服务组列表信息 https://{Endpoint}/v1/2349ba469daf4b7daf268bb0261d18b0/service-sets?object_id=a37bb4eb-c49e-4e88-bf77-944a75b0ce8a&limit=10&offset=0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data ServiceSetRecords object 查询服务组列表记录 表5 ServiceSetRecords 参数 参数类型 描述 offset Integer 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 limit Integer 每页显示个数，范围为1-1024 total Integer 查询服务组总数 records Array of ServiceSet objects 服务组列表 表6 ServiceSet 参数 参数类型 描述 set_id String 服务组id name String 服务组名称 description String 服务组描述 service_set_type Integer 服务组类型，0表示自定义服务组，1表示常用WEB服务，2表示常用远程登录和PING，3表示常用数据库 ref_count Integer 服务组被规则引用次数 project_id String 项目ID protocols Array of integers 协议列表，协议类型：TCP为6，UDP为17，ICMP为1，ICMPV6为58，ANY为-1,type为0手动类型时不能为空。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/{project_id}/service-sets 表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（.表示各对象之间层级的区分）获得 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表示预定义服务组

响应示例 状态码： 200 查询服务组列表返回值 { "data" : { "limit" : 50, "offset" : 0, "records" : [ { "name" : "test", "project_id" : "2349ba469daf4b7daf268bb0261d18b0", "protocols" : [ 6 ], "ref_count" : 2, "service_set_type" : 0, "set_id" : "6f475bad-5d33-45d1-98f8-c79f2f308d5a" } ], "total" : 1 } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

URI DELETE /v1/{project_id}/address-items 表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为9d80d070b6d44942af73c9c3d38e0429）地址组（id为e4884376-7efb-40e7-b98b-13668d6f8b85）下的地址组成员（id为d072ad2e-033c-40a9-b0b5-751f9c2943a6） https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items?fw_instance_id=7a004e79-0b8b-4679-ab20-267f3946e8ba&enterprise_project_id=default { "set_id" : "e4884376-7efb-40e7-b98b-13668d6f8b85", "address_item_ids" : [ "d072ad2e-033c-40a9-b0b5-751f9c2943a6" ] }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data IpsSwitchResponseDTO object 查询ips开关返回值数据 表5 IpsSwitchResponseDTO 参数 参数类型 描述 id String ips开关id，此处为互联网边界防护对象id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得 basic_defense_status Integer 基础防御状态，0表示关闭，1表示开启 virtual_patches_status Integer 虚拟补丁状态，0表示关闭，1表示开启

请求示例 通过租户id14181c1245cf4fd786824efe1e2b9388查询当前租户的补丁开启状态，用来加载入侵防御页面的虚拟补丁的开关状态。 https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&object_id=cfebd347-b655-4b84-b938-3c54317599b2

URI GET /v1/{project_id}/ips/switch 表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获取方式获取

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 data BlackWhiteListId object 添加黑白名单响应data 表6 BlackWhiteListId 参数 参数类型 描述 id String 黑白名单id name String 黑白名单名称，为黑白名单的地址 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 添加黑白名单响应 { "data" : { "id" : "6e91797b-05bd-4c69-9454-6af905178729", "name" : "10.10.1.3" } } 状态码： 400 Bad Request { "error_code" : "CFW.0020016", "error_msg" : "实例状态错误" }

请求示例 给项目id为9d80d070b6d44942af73c9c3d38e0429防护对象id为cfebd347-b655-4b84-b938-3c54317599b2的对象添加方向为源地址，地址为1.1.1.1，协议类型为tcp，端口为1的ipv4的白名单 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 }

URI POST /v1/{project_id}/black-white-list 表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参数 参数 是否必选 参数类型 描述 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：白名单 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 描述

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

响应示例 状态码： 200 删除服务组返回值 { "data" : { "id" : "221cfdca-3abf-4c30-ab0d-516a03c70866", "name" : "test" } } 状态码： 400 Bad Request { "error_code" : "CFW.00200004", "error_msg" : "所删除资源被引用，删除失败" }

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

响应示例 状态码： 200 开启关闭EIP防护状态返回值 { "data" : { "fail_eip_id_list" : [ ], "fail_eip_list" : [ ], "object_id" : "ae42418e-f077-41a0-9d3b-5b2f5ad9102b", "id" : "b0a2dacc-3886-4805-838e-281653d3cd1f" } }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 data EIPSwitchStatusVO object 改变EIP防护状态返回值data 表7 EIPSwitchStatusVO 参数 参数类型 描述 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（.表示各对象之间层级的区分）获得 fail_eip_id_list Array of strings 修改eip防护状态失败状态列表，状态包括成功"successful"，失败“fail” fail_eip_list Array of FailedEipInfo objects 修改eip防护状态失败信息列表 id String 防火墙id，可通过防火墙ID获取方式获取 表8 FailedEipInfo 参数 参数类型 描述 id String 修改状态失败的eipId。 error_message String 修改状态失败的错误码。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护 https://{Endpoint}/v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect { "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62", "status" : 0, "ip_infos" : [ { "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2", "public_ip" : "1.2.3.4" } ] } 关闭项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IPid为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（1.2.3.4）流量防护 /v1/857ddec2-55f2-4503-a93a-fe70021b743c/eip/protect { "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62", "status" : 1, "ip_infos" : [ { "id" : "4a589be0-b40a-4694-94ff-c0710af9a0a2", "public_ip" : "1.2.3.4" } ] }

请求参数 表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为0的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。 status 是 Integer EIP切换的状态，0表示防护中，1表示未防护 ip_infos 是 Array of ip_infos objects 切换防护状态的EIP信息列表 表5 ip_infos 参数 是否必选 参数类型 描述 id 否 String 弹性公网IP ID，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.id（.表示各对象之间层级的区分）获得。 public_ip 否 String 弹性公网IP IPv4地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ip（.表示各对象之间层级的区分）获得。 public_ipv6 否 String 弹性公网IP IPv6地址，可通过调用弹性IP列表查询接口获得，通过返回值中的data.records.public_ipv6（.表示各对象之间层级的区分）获得。

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。可通过如何获取用户Token获取。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of ResourceTag objects 防火墙标签列表 表4 ResourceTag 参数 是否必选 参数类型 描述 key 否 String 标签键 value 否 String 标签值 update_time 否 String 标签更新时间