创建弹性公网IP

最近更新时间:2020-08-04 08:22:23

1. 接口描述

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

本接口 (AllocateAddresses) 用于申请一个或多个弹性公网IP(简称 EIP)。

  • EIP 是专为动态云计算设计的静态 IP 地址。借助 EIP,您可以快速将 EIP 重新映射到您的另一个实例上,从而屏蔽实例故障。
  • 您的 EIP 与腾讯云账户相关联,而不是与某个实例相关联。在您选择显式释放该地址,或欠费超过24小时之前,它会一直与您的腾讯云账户保持关联。
  • 一个腾讯云账户在每个地域能申请的 EIP 最大配额有所限制,可参见 EIP 产品简介,上述配额可通过 DescribeAddressQuota 接口获取。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AllocateAddresses。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
AddressCount Integer EIP数量。默认值:1。
InternetServiceProvider String EIP线路类型。默认值:BGP。
  • 已开通静态单线IP白名单的用户,可选值:
    • CMCC:中国移动
    • CTCC:中国电信
    • CUCC:中国联通
    注意:仅部分地域支持静态单线IP。
InternetChargeType String EIP计费方式。
  • 已开通带宽上移白名单的用户,可选值:
    • BANDWIDTH_PACKAGE:共享带宽包付费(需额外开通共享带宽包白名单)
    • BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费
    • TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费
    默认值:TRAFFIC_POSTPAID_BY_HOUR。
  • 未开通带宽上移白名单的用户,EIP计费方式与其绑定的实例的计费方式一致,无需传递此参数。
InternetMaxBandwidthOut Integer EIP出带宽上限,单位:Mbps。
  • 已开通带宽上移白名单的用户,可选值范围取决于EIP计费方式:
    • BANDWIDTH_PACKAGE:1 Mbps 至 1000 Mbps
    • BANDWIDTH_POSTPAID_BY_HOUR:1 Mbps 至 100 Mbps
    • TRAFFIC_POSTPAID_BY_HOUR:1 Mbps 至 100 Mbps
    默认值:1 Mbps。
  • 未开通带宽上移白名单的用户,EIP出带宽上限取决于与其绑定的实例的公网出带宽上限,无需传递此参数。
AddressType String EIP类型。默认值:EIP。
  • 已开通Anycast公网加速白名单的用户,可选值:注意:仅部分地域支持加速IP。
AnycastZone String Anycast发布域。
  • 已开通Anycast公网加速白名单的用户,可选值:
    • ANYCAST_ZONE_GLOBAL:全球发布域(需要额外开通Anycast全球加速白名单)
    • ANYCAST_ZONE_OVERSEAS:境外发布域
    • [已废弃] ANYCAST_ZONE_A:发布域A(已更新为全球发布域)
    • [已废弃] ANYCAST_ZONE_B:发布域B(已更新为全球发布域)
    默认值:ANYCAST_ZONE_OVERSEAS。
ApplicableForCLB Boolean [已废弃] AnycastEIP不再区分是否负载均衡。原参数说明如下:
AnycastEIP是否用于绑定负载均衡。
  • 已开通Anycast公网加速白名单的用户,可选值:
    • TRUE:AnycastEIP可绑定对象为负载均衡
    • FALSE:AnycastEIP可绑定对象为云服务器、NAT网关、高可用虚拟IP等
    默认值:FALSE。
Tags.N Array of Tag 需要关联的标签列表。
BandwidthPackageId String BGP带宽包唯一ID参数。设定该参数且InternetChargeType为BANDWIDTH_PACKAGE,则表示创建的EIP加入该BGP带宽包并采用带宽包计费

3. 输出参数

参数名称 类型 描述
AddressSet Array of String 申请到的 EIP 的唯一 ID 列表。
TaskId String 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建加速IP

需开通Anycast公网加速白名单

输入示例

https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&AddressType=AnycastEIP
&<公共请求参数>

输出示例

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

示例2 创建常规IP

输入示例

https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&<公共请求参数>

输出示例

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

示例3 创建静态单线IP

需开通静态单线IP白名单

输入示例

https://vpc.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&InternetServiceProvider=CTCC
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AddressQuotaLimitExceeded 账户配额不足,每个腾讯云账户每个地域下最多可创建 20 个 EIP。
AddressQuotaLimitExceeded.DailyAllocate 申购次数不足,每个腾讯云账户每个地域每天申购次数为配额数*2 次。
InvalidParameterConflict 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。
目录