Enabling or Disabling an EIP
Function
This API is used to enable or disable EIP.
Debugging
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI
POST /v1/{project_id}/eip/protect
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum: 32 Maximum: 32 |
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
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. |
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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
IdObject object |
Data returned after enabling or disabling the EIP |
Status code: 400
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" : "100.85.121.62" } ] }
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" : "100.85.121.62" } ] }
Example Responses
Status code: 200
Return value for enabling or disabling EIP protection
{ "data" : { "id" : "449d165f-f1bc-4964-8cf4-e5420a4af529" } }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.