AssociateEipAddress

1. API Description

This API is used to bind an elastic IP to an instance in the same zone.

Note

• Only operations on elastic IPs in AVAILABLE status are supported.

• The instance of the ESXi operating system cannot bind an elastic IP.

• Elastic IPs can only be assigned to instances in the same zone.

• The instance to be assigned an elastic IP should be in status of RUNNING.

• The number of elastic IPs bound to an instance is limited. If you need more, please contact Zenlayer Support.

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

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

  • If the status of the elastic IP is ASSOCIATED, it means that the elastic IP has been bound.

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.
instanceId	Yes	String	Instance ID. To obtain the instance ID, you can call DescribeInstances and look for instanceId 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

Bind an elastic IP to an instance

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

Request：
{
    "eipId": "eipId1"，
    "instanceId": "instanceId1"
}

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	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_INSTANCE_RECYCLED	Instance is in recycle bin.
403	OPERATION_DENIED_INSTANCE_NOT_RUNNING	Instance status should be RUNNING.
403	OPERATION_DENIED_EIP_ZONE_NOT_SAME	Elastic IP and instance should be in the same zone.
403	FAILED_OPERATION_FOR_RECYCLE_RESOURCE	Elastic IP is in recycle bin.
400	OPERATION_DENIED_EIP_STATUS_NOT_AVAILABLE	Elastic IP status not supported.
403	OPERATION_DENIED_EIP_ESXI_INSTANCE_ASSIGN	Instance of ESXi operating system cannot bind an elastic IP.
403	OPERATION_DENIED_EIP_INSTANCE_EXCEED_LIMIT	Number of elastic IPs bound to an instance exceeds the limit.