1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (AssignIpv6Addresses) is used for ENI to apply for IPv6 addresses.
This API is completed asynchronously. To query the execution results of asynchronous tasks, use the RequestId returned by this API to poll the QueryTask API.
- The number of IP addresses that a single ENI can bind is limited. For more information on resource limitations, see ENI Usage Limits.
- You can specify the IPv6 addresses to apply for. The address type cannot be the primary IP. IPv6 address can temporarily only serve as an auxiliary IP.
- The address must be within the subnet of the ENI and cannot be occupied.* When one or more auxiliary IPv6 addresses are applied for on an ENI, the API will return a specified number of auxiliary IPv6 addresses within the subnet IP range of the ENI.
Default interface request rate limit: 100 times per second.
Interface update time: 2020-04-01 04:51:58.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: AssignIpv6Addresses |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| NetworkInterfaceId | Yes | No | String | ENI instance ID, e.g., eni-m6dyj72l.Example: eni-5u5biujl |
| Ipv6Addresses | No | No | Array of Ipv6Address | Specified IPv6 address list. Up to 10 at a time. It is calculated together with the input parameter Ipv6AddressCount to determine the quota. Either Ipv6AddressCount or IPv6 addresses must be specified. Example:View |
| Ipv6AddressCount | No | No | Uint64 | The number of automatically assigned IPv6 addresses. The total number of private IP addresses cannot exceed the quota. The quota is calculated in combination with the input parameter Ipv6Addresses. Either Ipv6Addresses or this field is required.Example: 1 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ipv6AddressSet | Array of Ipv6Address | List of IPv6 addresses allocated to the ENI. Example:View |
| taskId | Int64 | Des task taskId Example: 213415 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | The parameter value is invalid. |
| UnsupportedOperation.InvalidState | The resource status is invalid. |
| MissingParameter | Missing parameters. The request did not carry the required parameter. |
| LimitExceeded.Address | The number of IP addresses allocated has reached the upper limit. |
| UnsupportedOperation.UnassignCidrBlock | The IPv6 IP range is not allocated. |
| ResourceInUse.Address | The specified IP address is already in use. |
| UnsupportedOperation.MutexOperationTaskRunning | Exclusive operation task of resources is in progress. |