AssociateAddress

Prev Next

search by keyword

Recent Pages

Documentation

Last updated: 2021-11-30 11:35:54

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to bind an Elastic IP (EIP for short) to the specified private IP of an instance or ENI.

The EIP is essentially bound to the primary private IP of the primary ENI on a CVM instance.
The EIP binding will automatically unbind and release the public IP previously bound to the CVM instance.
To bind another EIP to the private IP of the specified ENI (not the primary private IP of the primary ENI), you must first unbind the EIP.
To bind an EIP to a NAT Gateway, use the AssociateNatGatewayAddress API.
EIP that is in arrears or blocked cannot be bound.
Only EIP in the UNBIND status can be bound.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: AssociateAddress.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
AddressId	Yes	String	The unique ID of the EIP, such as `eip-11112222`.
InstanceId	No	String	The ID of the instance to be bound, such as `ins-11112222`. You can query the instance ID by logging into the Console. You can also obtain the parameter value from the `InstanceId` field in the returned result of DescribeInstances API.
NetworkInterfaceId	No	String	The ID of the ENI to be bonud, such as `eni-11112222`. `NetworkInterfaceId` and `InstanceId` cannot be specified at the same time. You can query the ENI ID by logging into the Console. You can also obtain the parameter value from the `networkInterfaceId` field in the returned result of DescribeNetworkInterfaces API.
PrivateIpAddress	No	String	The private IP to be bound. If you specify `NetworkInterfaceId`, then you must also specify `PrivateIpAddress`, indicating the EIP is bound to the specified private IP of the specified ENI. At the same time, you must ensure the specified `PrivateIpAddress` is a private IP on the `NetworkInterfaceId`. You can query the private IP of the specified ENI by logging into the Console. You can also obtain the parameter value from the `privateIpAddress` field in the returned result of DescribeNetworkInterfaces API.
EipDirectConnection	No	Boolean	Whether to enable direct access when binding a specified EIP. For more information, see EIP Direct Access. Valid values: `True` and `False`; default value: `False`. You can set this parameter to `True` when binding an EIP to a CVM instance or an EKS elastic cluster. This parameter is currently in beta. To use it, please submit a ticket.

3. Output Parameters

Parameter Name	Type	Description
TaskId	String	The async task ID. You can use the DescribeTaskResult API to query the task status.
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Binding an EIP with an instance

Input Example

https://vpc.tencentcloudapi.com/?Action=AssociateAddress
&AddressId=eip-ek0cdz1g
&InstanceId=ins-1bmpb9tu
&<Common request parameters>

Output Example

{
  "Response": {
    "TaskId": "50121411",
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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

Error Code	Description
InvalidAccount.NotSupported	This account is not supported.
InvalidAddressId.Blocked	The specified EIP is in blocked status. When the EIP is in blocked status, it cannot be bound. You must first unblock it.
InvalidAddressId.NotFound	The specified EIP does not exist.
InvalidInstanceId.AlreadyBindEip	The specified instance has already been bound to an EIP. You must unbind the current EIP first before binding another EIP.
InvalidInstanceId.NotFound	Invalid instance ID. The specified instance ID does not exist.
InvalidNetworkInterfaceId.NotFound	The specified NetworkInterfaceId does not exist or the specified PrivateIpAddress is not on the NetworkInterfaceId.
InvalidParameterConflict	The two parameters cannot be specified at the same time, nor exist concurrently. EIP can only be bound to the instances or the specified private IPs of the specified ENIs.
InvalidParameterValue.AddressNotApplicable	An EIP cannot be bound with this type of instance.
InvalidParameterValue.AddressNotFound	Unable to find the address.
InvalidParameterValue.Combination	Invalid input parameters
InvalidParameterValue.InstanceDoesNotSupportAnycast	This instance does not support an Anycast EIP.
InvalidParameterValue.InstanceHasWanIP	This instance already has a WanIP (public IP).
InvalidParameterValue.InstanceNoWanIP	Request failed: this instance does not have a WanIP (public IP).
InvalidParameterValue.InstanceNormalPublicIpBlocked	Failed to bind: this IP is restricted
InvalidParameterValue.InvalidInstanceInternetChargeType	This IP is applicable only for pay-as-you-go instances that billed by hourly traffic and instances with bandwidth package.
InvalidParameterValue.InvalidInstanceState	Operation failed: the status of the instance does not allow this operation.
InvalidParameterValue.LBAlreadyBindEip	This CLB instance is already bound with an EIP.
InvalidParameterValue.NetworkInterfaceNotFound	The network interface ID was not found. The private IP address may not be configured on the network interface.
InvalidPrivateIpAddress.AlreadyBindEip	The specified private IP of the specified ENI has already been bound to an EIP. A private IP cannot be bound to more than one EIP.
MissingParameter	Missing parameter.

Recent Pages