AssociateAddress

Last updated: 2020-08-14 10:21:37

1. API Description

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

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

  • Essentially, binding an EIP to an instance (CVM) means binding an EIP to the primary private IP of the primary ENI on an instance.
  • When you bind an EIP to the primary private IP of the primary ENI, the previously bound public IP is automatically unbound and released.
  • To bind the EIP to the private IP of the specified ENI (not the primary private IP of the primary ENI), you must unbind the EIP before you can bind a new one.
  • To bind the EIP to a NAT gateway, use the API EipBindNatGateway
  • 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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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.

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 to 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

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

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

Command Line Interface

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
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.
InvalidAddressIdState.InArrears The specified EIP is in arrears.
InvalidAddressIdStatus.NotPermit The specified EIP cannot be bound in current status. It can only be bound in UNBIND status.
InvalidInstance.NotSupported This instance is not supported.
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.
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 Parameter missing. A required parameter is missing in the request.
MissingResourceId The entity to be bound to is missing. InstanceId, NetworkInterfaceId or PrivateIpAddress must be specified.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help