创建弹性公网IPv6

最近更新时间:2024-12-25 02:13:28

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(AllocateIPv6Addresses)用于申请一个或多个弹性公网IPv6(简称EIPv6)实例。

  • EIPv6 是您在腾讯云某个地域可以独立申请和持有的,固定不变的公网 IPv6 地址,提供与弹性公网 IPv4 一致的产品体验。
  • 通过弹性公网 IPv6,您可以快速将 EIPv6 实例绑定到云资源的内网 IPv6 地址上,实现为云资源快速开通 IPv6 公网带宽。
  • 您还可以按需将 EIPv6 实例绑定到其他云资源上,从而屏蔽实例故障。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AllocateIPv6Addresses。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
AddressName String EIP名称,用于申请EIP时用户自定义该EIP的个性化名称,默认值:未命名。
示例值:demo
AddressType String 弹性公网IPv6类型,可选值:

- EIPv6:普通IPv6
- HighQualityEIPv6:精品IPv6
注意:需联系产品开通精品IPv6白名单,且仅部分地域支持精品IPv6

默认值:EIPv6。
示例值:EIPv6
AddressCount Integer 申请的弹性公网IPv6数量,默认值:1。
示例值:1
InternetChargeType String 弹性公网IPv6计费方式,可选值:

- BANDWIDTH_PACKAGE:共享带宽包付费
- TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费

默认值:TRAFFIC_POSTPAID_BY_HOUR。
示例值:TRAFFIC_POSTPAID_BY_HOUR
InternetServiceProvider String 弹性公网IPv6线路类型,默认值:BGP。

已开通静态单线IP白名单的用户,可选值:
- CMCC:中国移动
- CTCC:中国电信
- CUCC:中国联通
注意:仅部分地域支持静态单线IP。
示例值:BGP
InternetMaxBandwidthOut Integer 弹性公网IPv6带宽上限,单位:Mbps。

可选值范围取决于EIP计费方式:

- BANDWIDTH_PACKAGE:1 Mbps 至 2000 Mbps
- TRAFFIC_POSTPAID_BY_HOUR:1 Mbps 至 100 Mbps

默认值:1 Mbps。
示例值:10
BandwidthPackageId String 带宽包唯一ID参数。
设定该参数且InternetChargeType为BANDWIDTH_PACKAGE,则表示创建的EIP加入该BGP带宽包并采用带宽包计费。
示例值:bwp-6jnvlsv4
Tags.N Array of Tag 需要关联的标签列表。
Egress String 弹性公网IPv6网络出口,可选值:

- CENTER_EGRESS_1:中心出口一
- CENTER_EGRESS_2:中心出口二
- CENTER_EGRESS_3:中心出口三
注意:不同运营商或资源类型对应的网络出口需要联系产品开白

默认值:CENTER_EGRESS_1。
示例值:center_egress1

3. 输出参数

参数名称 类型 描述
AddressSet Array of String 申请到的弹性公网 IPv6 地址的唯一 ID 列表。
示例值:["eipv6-m44ku5d2"]
TaskId String 异步任务TaskId,可以使用DescribeTaskResult接口查询任务状态。
示例值:61531428
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 申请按小时流量计费的常规BGP IPv6地址。

申请按小时流量计费的常规BGP IPv6地址。

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateIPv6Addresses
<公共请求参数>

{
    "AddressCount": 1
}

输出示例

{
    "Response": {
        "AddressSet": [
            "eipv6-m44ku5d2"
        ],
        "TaskId": "61531421",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterConflict 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.BandwidthOutOfRange 带宽超出限制。
InvalidParameterValue.BandwidthTooSmall 选择带宽低于可允许的最小范围。
InvalidParameterValue.Combination 非法入参组合。
InvalidParameterValue.UnavailableZone 该可用区不可用。
LimitExceeded.BandwidthPackageResourceQuota 当前带宽包加入资源上限。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.AccountNotSupported 不支持的账户。