文档首页/ 云防火墙 CFW/ API参考 (联盟区域) / API/ EIP管理/ 弹性IP开启关闭
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

弹性IP开启关闭

功能介绍

开启关闭EIP，客户购买EIP后首次开启EIP防护前需使用ListEips同步EIP资产，sync字段设置为1。

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的
表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（.表示各对象之间层级的区分）获得。

响应参数

状态码：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"
  } ]
}

响应示例

状态码：200

开启关闭EIP防护状态返回值

{
  "data": {
    "fail_eip_id_list": [],
    "fail_eip_list": [],
    "object_id": "ae42418e-f077-41a0-9d3b-5b2f5ad9102b",
    "id": "b0a2dacc-3886-4805-838e-281653d3cd1f"
  }

状态码

状态码

描述

200

开启关闭EIP防护状态返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： EIP管理