Function

Enable and disable EIPs, you need to use ListEips to synchronize EIP assets and set the sync field to 1 before enabling EIP protection for the first time after purchasing an EIP.

URI

POST /v1/{project_id}/eip/protect

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID Minimum: 32 Maximum: 32

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	No	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
object_id	Yes	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. Minimum: 36 Maximum: 36
status	Yes	Integer	EIP Status,0:protected,1:unprotected Minimum: 0 Maximum: 1
ip_infos	Yes	Array of ip_infos objects	EIP information list Array Length: 0 - 50

**Table 5** ip_infos
Parameter	Mandatory	Type	Description
id	No	String	EIP data ID Minimum: 36 Maximum: 36
public_ip	No	String	EIP Minimum: 0 Maximum: 255
public_ipv6	No	String	EIP IPv6

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
data	EIPSwitchStatusVO object	Eip Switch Status Vo

**Table 7** EIPSwitchStatusVO
Parameter	Type	Description
object_id	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
fail_eip_id_list	Array of strings	failed eip id list
id	String	ID

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code Minimum: 8 Maximum: 36
error_msg	String	Description Minimum: 2 Maximum: 512

Example Requests

Enable EIP (100.85.121.62) traffic protection.

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"
  } ]
}

Disable EIP (100.85.121.62) traffic protection.

/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"
  } ]
}

Example Responses

Status code: 200

Return value for enabling or disabling EIP protection

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

Status Codes

Status Code	Description
200	Return value for enabling or disabling EIP protection
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Enabling or Disabling an EIP,To enable and disable EIP, you must use ListEips to synchronize EIP assets before enabling EIP protection for the first time after purchasing EIP, and set the sync field to 1.