AssignIpv6Addresses

Last updated: 2021-08-02 17:21:52

1. API Description

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

This API is used to apply for an IPv6 address for the ENI.

This API is completed asynchronously. If you need to query the execution result of an async task, please use the RequestId returned by this API to poll the DescribeVpcTaskResult API.

  • The number of IPs bound with an ENI is limited. For more information, see ENI Use Limits.
  • You can apply for a specified IPv6 address. Currently, the IPv6 address can only be used as a secondary IP, instead of the primary IP.
  • The address must be an idle IP in the subnet to which the ENI belongs.
  • When applying for one or more secondary IPv6 addresses for an ENI, the API will return the specified number of secondary IPv6 addresses in the subnet range where the ENI is located.

A maximum of 20 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: AssignIpv6Addresses.
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.
NetworkInterfaceId Yes String The ID of the ENI instance, such as eni-m6dyj72l.
Ipv6Addresses.N No Array of Ipv6Address A list of IPv6 addresses. You can specify a maximum of 10 at one time. The quota is calculated together with that of Ipv6AddressCount, a required input parameter alternative to this one.
Ipv6AddressCount No Integer The number of automatically assigned IPv6 addresses. The total number of private IP addresses cannot exceed the quota. The quota is calculated together with that of Ipv6Addresses, a required input parameter alternative to this one.

3. Output Parameters

Parameter Name Type Description
Ipv6AddressSet Array of Ipv6Address The list of IPv6 addresses assigned to ENIs.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Assigning the specified IPv6 address

Input Example

https://vpc.tencentcloudapi.com/?Action=AssignIpv6Addresses
&NetworkInterfaceId=eni-5u5biujl
&Ipv6Addresses.0.Address=3402:4e00:20:1202::1
&Ipv6Addresses.0.Primary=false
&Ipv6Addresses.0.Description=test1
&Ipv6Addresses.1.Address=3402:4e00:20:1202::2
&Ipv6Addresses.1.Primary=false
&Ipv6Addresses.1.Description=test2
&<Common request parameters>

Output Example

{
  "Response": {
    "Ipv6AddressSet": [
      {
        "Address": "3402:4e00:20:1202::1",
        "AddressId": "",
        "Primary": false,
        "Description": "test1",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      },
      {
        "Address": "3402:4e00:20:1202::2",
        "AddressId": "",
        "Primary": false,
        "Description": "test2",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      }
    ],
    "RequestId": "4a8d6fc0-bc48-4394-b1f7-2818a217359a"
  }
}

Example2 Assigning IPv6 addresses automatically based on Ipv6AddressCount

Input Example

https://vpc.tencentcloudapi.com/?Action=AssignIpv6Addresses
&NetworkInterfaceId=eni-5u5biujl
&Ipv6AddressCount=2
&<Common request parameters>

Output Example

{
  "Response": {
    "Ipv6AddressSet": [
      {
        "Address": "3402:4e00:20:1202:0:8d05:c272:f514",
        "AddressId": "",
        "Primary": false,
        "Description": "",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      },
      {
        "Address": "3402:4e00:20:1202:0:8d05:c272:f559",
        "AddressId": "",
        "Primary": false,
        "Description": "",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      }
    ],
    "RequestId": "4a8d6fc0-bc48-4394-b1f7-2818a217359a"
  }
}

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
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Malformed Invalid input parameter format.
LimitExceeded.Address The number of assigned IP addresses has reached the upper limit.
MissingParameter Missing parameter.
ResourceInUse.Address The specified IP address is already in use.
ResourceNotFound The resource does not exist.
UnsupportedOperation.InvalidState Invalid resource status.
UnsupportedOperation.MutexOperationTaskRunning The resource mutual exclusion operation is being executed.
UnsupportedOperation.UnassignCidrBlock IPv6 IP range is not assigned.