tencent cloud

All product documents
Virtual Private Cloud
DocumentationVirtual Private CloudAPI DocumentationElastic IPv6 APIsAssociateIPv6Address
AssociateIPv6Address
Download PDF
Last updated: 2025-02-18 10:40:32
AssociateIPv6Address
Last updated: 2025-02-18 10:40:32
Download PDF

1. API Description

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

This API is used to bind an EIPv6 instance to the private IPv6 address configured on the CVM or ENI.

  • Binding an EIPv6 to the CVM essentially indicates binding the EIPv6 to the private IPv6 address configured on the ENI of the CVM.
  • Before binding an EIPv6 to the private IPv6 of a specified ENI, ensure that the private IPv6 address is unbound before the binding operation is performed.

A maximum of 20 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 Params. The value used for this API: AssociateIPv6Address.
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.
IPv6AddressId Yes String Unique ID of the EIPv6, such as eipv6-11112222.
NetworkInterfaceId No String ID of the ENI to be bound, such as eni-11112222. NetworkInterfaceId and InstanceId cannot be specified at the same time. The ENI ID can be queried by logging in to the console or obtained from the networkInterfaceId field in the returned value of the DescribeNetworkInterfaces API.
PrivateIPv6Address No String Private IPv6 to be bound. If NetworkInterfaceId is specified, PrivateIPv6Address must also be specified, which indicates that the EIP will be bound to the specified private IPv6 of the specified ENI. At the same time, it shall be ensured that the specified PrivateIPv6Address is a private IPv6 on the specified NetworkInterfaceId. The specified ENI's private IPv6 can be queried by logging in to the console or obtained from the Ipv6AddressSet.Address field in the returned value of the DescribeNetworkInterfaces API.

3. Output Parameters

Parameter Name Type Description
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.

4. Example

Example1 Binding an EIPv6 to the ENI

This example shows you how to bind an EIPv6 to the ENI.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateIPv6Address
<Common request parameters>

{
    "IPv6AddressId": "eipv6-3lxpc6sh",
    "NetworkInterfaceId": "eni-0c454zph",
    "PrivateIPv6Address": "fc00:200:300:700:0:9c64:2c95:b711"
}

Output Example

{
    "Response": {
        "RequestId": "631011dd-6dfa-41b5-be7c-47bd61d82978"
    }
}

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

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
InvalidParameter A parameter error occurred.
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 The parameter value is invalid.
InvalidParameterValue.AddressIdMalformed This IP address ID is invalid.
InvalidParameterValue.AddressIpNotFound IP address not found.
InvalidParameterValue.AddressNotApplicable An EIP cannot be bound with this type of instance.
InvalidParameterValue.MissingAssociateEntity The bound instance is missing.
InvalidParameterValue.NetworkInterfaceInstanceNotSupport The instance bound to the ENI does not support binding the EIPv6.
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.
OperationDenied.AddressInArrears The specified public IP is isolated.
UnsupportedOperation.AddressStatusNotPermit This operation is not supported by the IP address status.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon