文档首页> 云防火墙 CFW> API参考> API> EIP管理> 弹性IP开启关闭
更新时间：2024-06-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

弹性IP开启关闭

功能介绍

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

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/eip/protect

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目id，用户支持企业项目后，由企业项目生成的id。

fw_instance_id

否

String

防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，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。

最小长度：36

最大长度：36

status

是

Integer

EIP状态，0表示防护中，1表示未防护

最小值：0

最大值：1

ip_infos

是

Array of ip_infos objects

EIP信息列表

数组长度：0 - 50
表5 ip_infos

参数

是否必选

参数类型

描述

id

否

String

弹性公网IP数据ID

最小长度：36

最大长度：36

public_ip

否

String

弹性公网IP地址

最小长度：0

最大长度：255

public_ipv6

否

String

弹性公网IP地址IPV6

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

data

EIPSwitchStatusVO object

改变EIP防护状态返回值data
表7 EIPSwitchStatusVO

参数

参数类型

描述

object_id

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。

fail_eip_id_list

Array of strings

修改eip防护状态失败列表。

id

String

ID

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

  • 开启项目id为857ddec2-55f2-4503-a93a-fe70021b743c，防护对象id为6d3db4fd-fd58-4d8e-914b-ef91aa268f62弹性公网IP数据id为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（100.85.121.62）流量防护

    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弹性公网IP数据id为4a589be0-b40a-4694-94ff-c0710af9a0a2的 EIP（100.85.121.62）流量防护

    /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" : [ ],
    "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管理
分享：

    相关文档

    相关产品