1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API is used for the initial allocation of public network bandwidth to an IPv6 address.
Default interface request rate limit: 20 times per second.
Interface update time: 2025-09-02 18:06:31.
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: AllocateIp6AddressesBandwidth |
| 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 |
| Ip6Addresses | Yes | No | Array of String | IPv6 address for which public network access is required. Example: 2402:4e00:1011:9b02:0:98e8:f0fd:3a85 |
| InternetMaxBandwidthOut | No | No | Int64 | Bandwidth, in Mbps. The default value is 1 Mbps. Example: 50 |
| InternetChargeType | No | No | String | Network billing mode. IPV6 currently supports TRAFFIC_POSTPAID_BY_HOUR. The default is TRAFFIC_POSTPAID_BY_HOUR. Example: TRAFFIC_POSTPAID_BY_HOUR |
| BindResourceType | No | No | String | Binding resource type. Valid values: BIND_BMS: indicates BMS IPv6; BIND_INSTANCE_OR_EIP indicates instance IPv6. Example: BIND_BMS |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| AddressSet | Array of String | Unique ID list of EIP IPv6. Example: eip-68dqs5ri |
| TaskId | String | Asynchronous task TaskId. The task status can be queried using the DescribeTaskResult API. Example: 194395704 |
| 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 |
|---|---|
| InvalidParameter | Invalid input parameters. |
| InvalidParameterValue.Malformed | Invalid input format. |
| InvalidParameter.Coexist | The parameters must not be specified simultaneously. |
| InvalidParameterValue.LimitExceeded | The parameter value exceeds the limit. |
| InternalServerError | Internal operation error. |