产品动态
产品公告
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to bind an Elastic IP (EIP for short) to the specified private IP of an instance or ENI.
UNBIND status can be bound.A maximum of 10 requests can be initiated per second for this API.
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 Params. The value used for this API: AssociateAddress. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. 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, lb-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 | Specify whether to configure direct access when binding EIPs. For details, see EIP Direct Access. Valid values: True and False (default). This parameter can be set to True when binding EIPs to a CVM instance or EKS cluster. It is in a beta test. To try it out, please submit a ticket. |
| 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to bind an EIP to an instance.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateAddress
<Common request parameters>
{
"InstanceId": "ins-1bmpb9tu",
"AddressId": "eip-ek0cdz1g"
}{
"Response": {
"TaskId": "50121411",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.AddressEniInfoNotFound | The ENI information is not available in this address. |
| FailedOperation.TaskFailed | Task execution failed. |
| 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.AddressIdMalformed | This IP address ID is invalid. |
| 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.InstanceHasNoWanIP | The instance does not have a public IP. |
| InvalidParameterValue.InstanceHasWanIP | This instance already has a WanIP (public IP). |
| InvalidParameterValue.InstanceIdMalformed | Incorrect instance ID. |
| InvalidParameterValue.InstanceNoWanIP | Request failed: this instance does not have a WanIP (public IP). |
| InvalidParameterValue.InstanceNormalPublicIpBlocked | Failed to bind: this IP is restricted |
| InvalidParameterValue.InstanceNotMatchAssociateEni | The ENI and the IP are bound with different instances. |
| 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.MissingAssociateEntity | The bound instance is missing. |
| InvalidParameterValue.NetworkInterfaceNotFound | The network interface ID was not found. The private IP address may not be configured on the network interface. |
| InvalidParameterValue.ResourceNotSupport | The resource does not support this operation. |
| 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. |
| LimitExceeded.InstanceAddressQuota | Exceeded the upper limit of the EIPs bound to the instance. |
| MissingParameter | Missing parameter. |
| OperationDenied.AddressInArrears | The specified public IP is isolated. |
| OperationDenied.MutexTaskRunning | Mutually exclusive tasks are executing. |
| UnsupportedOperation.ActionNotFound | The port does not exist. |
| UnsupportedOperation.AddressIpNotSupportInstance | The IP address bound with this instance does not support this operation |
| UnsupportedOperation.AddressStatusNotPermit | This operation is not supported by the IP address status. |
| UnsupportedOperation.IncorrectAddressResourceType | This type of address does not support this operation. |
| UnsupportedOperation.InstanceStateNotSupported | This operation is not supported by the status of the instance bound with the IP address. |
| UnsupportedOperation.InvalidAction | Unsupported operation. |
| UnsupportedOperation.InvalidAddressInternetChargeType | This operation is not allowed under the network billing mode of the IP address. |
| UnsupportedOperation.IspNotSupported | This ISP does not support this operation. |
文档反馈