1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API is used to allocate IPv6 IP ranges.
- Before using this API, you need to have an existing VPC instance. If you do not have one, you can create it using the API CreateVpc.
- Each VPC can only request one IPv6 IP range.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-04-30 17:00:18.
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: AssignIpv6CidrBlock |
| 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 |
| VpcId | Yes | No | String | VPC instance ID, e.g., vpc-f49l6u0z. Example: vpc-f49l6u0z |
| AddressType | No | No | String | IP range type. 0: GUA, 1: ULA. 0 by default. Example: "GUA" |
| Ipv6CidrBlock | No | No | String | Ipv6Cidr can be specified only when AddressType is set to an IPv6 CIDR of GUA. For example: 3402:4e00:20:1000::/56. Example: 2001:db8:1a:8000::/56 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Ipv6CidrBlock | String | Allocated IPv6 IP ranges, e.g., 3402:4e00:20:1000::/56 Example: 3402:4e00:20:1000::/56 |
| IpAddressType | String | IP address type. IPv4: v4 type; IPv6: v6 type. Example: IPv4/IPv6 |
| ISPType | String | ISP type of the IPv6 CIDR block. Valid values: 'BGP' (default type), 'CMCC', 'CTCC', and 'CUCC'. Example: BGP |
| AddressType | String | Requested IPv6 CIDR type. Valid values: GUA; ULA. Example: GUA |
| 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 |
|---|---|
| LimitExceeded.CidrBlock | The number of IP ranges allocated to the VPC has reached the upper limit. |
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceInsufficient.CidrBlock | The IP range resources are insufficient. |