tencent cloud

Virtual Private Cloud

Release Notes and Announcements
Release Notes
Announcements
Tencent Cloud Network Overview
Product Introduction
Overview
Strengths
Use Cases
Concepts
Quota Limit
Service Regions and Service Providers
Purchase Guide
Billing Overview
Payment Overdue
Quick Start
Network Planning
VPC Connections
Building Up an IPv4 VPC
Operation Guide
Network Topology
Network performance dashboard
Virtual Private Cloud (VPC)
Subnets
Route Tables
Elastic IP
HAVIPs
Elastic Network Interface
Bandwidth Package
Network Connection
Security Management
Diagnostic Tools
Alarming and Monitoring
Practical Tutorial
View the Total Bandwidth for Single-Region Traffic-Based Billing
Migrating from the Classic Network to VPC
Best Practices of Security Group Change
Configuring CVM Instance as Public Gateway
Building HA Primary/Secondary Cluster with HAVIP + Keepalived
Hybrid Cloud Primary/Secondary Communication (DC and VPN)
Hybrid Cloud Primary/Secondary Communication (CCN and VPN)
CVM Access to Internet Through EIP
Troubleshooting
VPCs or Subnets Cannot Be Deleted
Network Disconnection After Connecting Two VPCs over CCN
Failed to Ping CVMs in the Same VPC
API Documentation
History
Introduction
API Category
Making API Requests
VPC APIs
Route Table APIs
Elastic Public IP APIs
Elastic IPv6 APIs
Highly Available Virtual IP APIs
ENI APIs
Bandwidth Package APIs
NAT Gateway APIs
Direct Connect Gateway APIs
Cloud Connect Network APIs
Network ACL APIs
Network Parameter Template APIs
Network Detection-Related APIs
Flow Log APIs
Gateway Traffic Monitor APIs
Private Link APIs
Traffic Mirroring APIs
Other APIs
Subnet APIs
VPN Gateway APIs
Security Group APIs
Snapshot Policy APIs
Error Codes
Data Types
FAQs
General
Connection
Security
Contact Us
Glossary

AllocateIp6AddressesBandwidth

PDF
Focus Mode
Font Size
Last updated: 2025-11-13 20:43:26

1. API Description

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

This API is used to allocate IPv6 public network bandwidth for classic elastic public IPv6 addresses.

  • Classic elastic public IPv6 addresses only have the private network communication capability by default. They can have the IPv6 public network communication capability and be displayed in the list of Classic Elastic Public IPv6 only after IPv6 public network bandwidth is allocated in the console or by calling this API.
  • You can allocate public network bandwidth for one or multiple Classic elastic public IPv6 addresses each time.

A maximum of 20 requests can be initiated per second for this API.

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 Params. The value used for this API: AllocateIp6AddressesBandwidth.
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.
Ip6Addresses.N Yes Array of String IPv6 addresses that require the public network access capability.
InternetMaxBandwidthOut No Integer Bandwidth, in Mbps. The default value is 1 Mbps.
InternetChargeType No String Network billing mode. IPv6 addresses currently support "TRAFFIC_POSTPAID_BY_HOUR" and "BANDWIDTH_PACKAGE". The default network billing mode is "TRAFFIC_POSTPAID_BY_HOUR".
BandwidthPackageId No String Bandwidth package ID. This ID is required for standard accounts to add the IPv6 addresses to the bandwidth package, thus using the billing mode.
Tags.N No Array of Tag List of tags to be associated.

3. Output Parameters

Parameter Name Type Description
AddressSet Array of String List of unique IDs of Classic elastic Public IPv6 instances.
TaskId String Asynchronous task ID. You can call 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.

4. Example

Example1 Specify one or multiple IPv6 addresses to enable public network access capability

Specify one or multiple IPv6 addresses to enable public network access capability

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateIp6AddressesBandwidth
<Common request parameters>

{
    "Ip6Addresses": [
        "2402:4e00:1000:200:0:8d8a:60b7:87f8"
    ],
    "InternetMaxBandwidthOut": 1
}

Output Example

{
    "Response": {
        "AddressSet": [
            "eip-68dqs5ri"
        ],
        "TaskId": "194395704",
        "RequestId": "283a29bf-982d-4d55-984a-0d464f61f9ae"
    }
}

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
FailedOperation.BalanceInsufficient Insufficient account balance.
FailedOperation.TaskFailed Task execution failed.
InternalServerError Internal error.
InvalidAccount.NotSupported This account is not supported.
InvalidInstanceId.NotFound Invalid instance ID. The specified instance ID does not exist.
InvalidParameter A parameter error occurred.
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameterValue.AddressIpNotFound IP address not found.
InvalidParameterValue.AddressIpNotInVpc The IP address does not exist in the VPC.
InvalidParameterValue.AddressPublished This IPv6 address has already been published.
InvalidParameterValue.BandwidthOutOfRange The bandwidth exceeds the limit.
InvalidParameterValue.BandwidthPackageNotFound Failed to query the bandwidth package
InvalidParameterValue.InvalidIpv6 Invalid IPv6 addresses.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
UnsupportedOperation.BandwidthPackageIdNotSupported This bandwidth package does not support this operation.
UnsupportedOperation.InvalidAddressInternetChargeType This operation is not allowed under the network billing mode of the IP address.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback