1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
该接口用于给IPv6地址初次分配公网带宽
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AllocateIp6AddressesBandwidth。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Ip6Addresses.N | 是 | Array of String | 需要开通公网访问能力的IPV6地址 示例值:2402:4e00:1011:9b02:0:98e8:f0fd:3a85 |
InternetMaxBandwidthOut | 否 | Integer | 带宽,单位Mbps。默认是1Mbps 示例值:50 |
InternetChargeType | 否 | String | 网络计费模式。IPV6当前支持"TRAFFIC_POSTPAID_BY_HOUR","BANDWIDTH_PACKAGE"。默认网络计费模式是"TRAFFIC_POSTPAID_BY_HOUR"。 示例值:TRAFFIC_POSTPAID_BY_HOUR |
BandwidthPackageId | 否 | String | 带宽包id,上移账号,申请带宽包计费模式的ipv6地址需要传入. 示例值:bwp-12345678 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AddressSet | Array of String | 弹性公网 IPV6 的唯一 ID 列表。 示例值:eip-68dqs5ri |
TaskId | String | 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 示例值:194395704 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 指定ipv6地址开通公网访问能力
指定ipv6地址开通公网访问能力。
输入示例
https://vpc.tencentcloudapi.com/?Action=AllocateIp6AddressesBandwidth
&Ip6Addresses.0=2402:4e00:1000:200:0:8d8a:60b7:87f8
&InternetMaxBandwidthOut=1
&<公共请求参数>
输出示例
{
"Response": {
"AddressSet": [
"eip-68dqs5ri"
],
"TaskId": "194395704",
"RequestId": "283a29bf-982d-4d55-984a-0d464f61f9ae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.BalanceInsufficient | 账户余额不足。 |
FailedOperation.TaskFailed | 任务执行失败。 |
InternalServerError | 操作内部错误。 |
InvalidAccount.NotSupported | 不支持此账户。 |
InvalidInstanceId.NotFound | 无效实例ID。指定的实例ID不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameterValue.AddressIpNotFound | IP地址未找到。 |
InvalidParameterValue.AddressIpNotInVpc | VPC中不存在此IP地址。 |
InvalidParameterValue.AddressPublished | 该IPv6地址已经发布。 |
InvalidParameterValue.BandwidthOutOfRange | 带宽超出限制。 |
InvalidParameterValue.BandwidthPackageNotFound | 未查询到该带宽包。 |
InvalidParameterValue.InvalidIpv6 | 无效的IPv6地址。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
UnsupportedOperation.BandwidthPackageIdNotSupported | 该带宽包不支持此操作。 |
UnsupportedOperation.InvalidAddressInternetChargeType | 该地址的网络付费方式不支持此操作。 |