UnAssociateEipAddress

1. API Description

This API is used to unbind an elastic IP from an instance.

Note

• Operations on elastic IPs in ASSOCIATED and AVAILABLE status are supported. For elastic IPs with AVAILABLE status, no change occurs.

• Operations on elastic IPs in ASSOCIATED status will change the status to UNACCOSCIATING.

• This API is an async API. A request ID is returned after the request is sent. However, it does not mean the unbinding has been completed. You can use DescribeEipAddresses to query the status of the elastic IP.

  • If the status of the elastic IP is UNASSOCIATING, it means that the elastic IP is being unbound. Only query operations are allowed during UNASSOCIATING.

  • If the status of the elastic IP is AVAILABLE, it means that the elastic IP has been unbound.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
eipId	Yes	String	ID of an elastic IP. To obtain the elastic IP ID, you can call DescribeEipAddresses and look for eipId in the response.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Example

Unbind an elastic IP from an instance

POST /api/v2/bmc HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: UnAssociateEipAddress
<Common Request Params>

Request：
{
  "eipId": "eipId1"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {  
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_EIP_NOT_FOUND	Elastic IP does not exist.
403	FAILED_OPERATION_FOR_RECYCLE_RESOURCE	Elastic IP is in recycle bin.
403	OPERATION_DENIED_EIP_STATUS_NOT_SUPPORT	Elastic IP status not supported.