产品动态
产品公告
Domain name for API request: vpc.intl.tencentcloudapi.com.
This API is used to apply for one or more Elastic IPv6 (EIPv6) instances.
A maximum of 20 requests can be initiated per second for this API.
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: AllocateIPv6Addresses. |
| 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. |
| AddressName | No | String | EIPv6 name, which is the custom EIPv6 name given by the user when the user applies for the EIPv6. Default: not named. |
| AddressType | No | String | Indicates the type of EIPv6. Valid values: - EIPv6: common IPv6 - HighQualityEIPv6: dedicated IPv6 Note: Contact the product team to enable the dedicated IPv6 allowlist. The dedicated IPv6 is only supported in some regions. Default: EIPv6. |
| AddressCount | No | Integer | Number of applied EIPv6 addresses. Default: 1. |
| InternetChargeType | No | String | Indicates the billing method of EIPv6. Valid values: - BANDWIDTH_PACKAGE: billed by Bandwidth Package - TRAFFIC_POSTPAID_BY_HOUR: postpaid by traffic on an hourly basis Default: TRAFFIC_POSTPAID_BY_HOUR. |
| InternetServiceProvider | No | String | Indicates the type of EIPv6 line. Default: BGP. For a user who has enabled the static single-line IP allowlist, valid values include: - CMCC: China Mobile - CTCC: China Telecom - CUCC: China Unicom Note: The static single-line IP is only supported in some regions. |
| InternetMaxBandwidthOut | No | Integer | EIPv6 bandwidth cap, in Mbps. Valid values depend on the EIP billing method: - BANDWIDTH_PACKAGE: 1 Mbps to 2000 Mbps - TRAFFIC_POSTPAID_BY_HOUR: 1 Mbps to 100 Mbps Default: 1 Mbps. |
| BandwidthPackageId | No | String | Unique ID of the bandwidth package. Setting this parameter and having InternetChargeType as BANDWIDTH_PACKAGE indicate that the created EIP will join this BGP bandwidth package and the billing method of bandwidth package will be adopted. |
| Tags.N | No | Array of Tag | List of tags to be associated. |
| Egress | No | String | EIPv6 network egress. Valid values: - CENTER_EGRESS_1: Central egress point 1 - CENTER_EGRESS_2: Central egress point 2 - CENTER_EGRESS_3: Central egress point 3 Note: The network egress for different Internet Service Providers (ISPs) or resource types requires contacting the product team for enablement. Default: CENTER_EGRESS_1. |
| Parameter Name | Type | Description |
|---|---|---|
| AddressSet | Array of String | List of unique IDs of applied EIPv6 addresses. |
| TaskId | String | Async task ID. You can use the DescribeTaskResult API to query the task status. |
| 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. |
This example shows you how to apply for a regular BGP IPv6 address billed by hourly traffic.
POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateIPv6Addresses
<Common request parameters>
{
"AddressCount": 1
}{
"Response": {
"AddressSet": [
"eipv6-m44ku5d2"
],
"TaskId": "61531421",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| 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.BandwidthOutOfRange | The bandwidth exceeds the limit. |
| InvalidParameterValue.BandwidthTooSmall | The selected bandwidth is smaller than the minimum permissible range. |
| InvalidParameterValue.Combination | Invalid input parameters |
| InvalidParameterValue.UnavailableZone | This availability zone is unavailable. |
| LimitExceeded.BandwidthPackageResourceQuota | Number of resources added to this bandwidth package reached the upper limit. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation.AccountNotSupported | This account is not supported. |
文档反馈