调用AllocateEipAddress接口申请弹性公网IP（EIP）。

API描述

请确保在使用该接口前，已充分了解EIP的收费方式和价格。详细信息，请参见计费概述。

调用本接口后将在指定的地域内随机获取一个状态为Available的弹性公网IP。弹性公网IP在传输层目前只支持ICMP、TCP和UDP协议，不支持IGMP和SCTP等协议。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AllocateEipAddress

要执行的操作，取值：AllocateEipAddress。

RegionId String 是 cn-hangzhou

弹性公网IP所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

Bandwidth String 否 5

EIP的带宽峰值，取值范围：1~200，单位为Mbps。

默认值为5。

Period Integer 否 1

购买时长。

当PricingCycle取值Month时，Period取值范围为1~9。

当PricingCycle取值Year时，Period取值范围为1~5。

如果InstanceChargeType参数的值为PrePaid时，该参数必选，如果InstanceChargeType参数的值为PostPaid时，该参数不填。

ISP String 否 BGP

线路类型，取值：

  • BGP：BGP（多线）线路。

    BGP（多线）线路在全球有多达89条优质BGP线路，在中国内地的每个地域均提供电信、联通、移动、铁通、网通、教育网、广电、鹏博士、方正宽带等多条线路的直连覆盖。

  • BGP_PRO：BGP（多线）精品线路。

    BGP（多线）精品线路是一种优化海外回国流量的公网线路，可以提高国际业务访问质量。相比普通BGP（多线）线路， BGP（多线）精品线路通过底层网络直连回国，无需绕行国际运营商出口，时延更低。

目前，全部地域都支持BGP（多线）线路EIP，仅中国（香港）地域支持BGP（多线）精品线路EIP。

说明 如果是开通了单线带宽白名单的用户，ISP字段可以设置为ChinaTelecom（中国电信）、ChinaUnicom（中国联通）和ChinaMobile（中国移动）；如果是杭州金融云用户，该字段必填，取值：BGP_FinanceCloud。
ActivityId Long 否 None

特殊活动ID，无需配置此参数。
Netmode String 否 public

网络类型，取值为public（公网）。

AutoPay Boolean 否 false

是否自动付费，取值：

false：不开启自动付费，生成订单后需要到订单中心完成支付。

true：开启自动付费，自动支付订单。

当InstanceChargeType参数的值为PrePaid时，该参数必选；当InstanceChargeType参数的值为PostPaid时，该参数可不填。

PricingCycle String 否 Month

包年包月的计费周期，取值：

Month（默认值）：按月付费。

Year：按年付费。

当InstanceChargeType参数的值为PrePaid时，该参数必选；当InstanceChargeType参数的值为PostPaid时，该参数可不填。

InstanceChargeType String 否 PostPaid

EIP的计费方式，取值：

PrePaid：包年包月。

PostPaid（默认值）：按量计费。

当InstanceChargeType取值为PrePaid时，InternetChargeType必须取值PayByBandwidth；当InstanceChargeType取值为PostPaid时，InternetChargeType可取值PayByBandwidth或PayByTraffic。

InternetChargeType String 否 PayByTraffic

EIP的计量方式，取值：

PayByBandwidth（默认值）：按带宽计费。

PayByTraffic：按流量计费。

当InstanceChargeType取值为PrePaid时，InternetChargeType必须取值PayByBandwidth。

当InstanceChargeType取值为PostPaid时，InternetChargeType可取值PayByBandwidth或PayByTraffic。

ResourceGroupId String 否 rg-acfmxazffggds****

资源组ID。
ClientToken String 否 0c593ea1-3bea-11e9-b96b-88e9fe637760

保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多详情，请参见如何保证幂等性。

返回数据

名称 类型 示例值 描述
EipAddress String 12.xx.xx.78

分配的EIP。
AllocationId String eip-25877c70gddh****

EIP的ID。
OrderId Long 10

订单号，仅InstanceChargeType取值为PrePaid时返回。

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。
ResourceGroupId String rg-acfmxazfdgdg****

资源组ID。

示例

请求示例

http(s)://vpc.aliyuncs.com/?Action=AllocateEipAddress
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
<ResourceGroupId>rg-acfmxazfdgdg****</ResourceGroupId>
<AllocationId>eip-25877c70gddh****</AllocationId>
<EipAddress>12.xx.xx.78</EipAddress>
<OrderId>10</OrderId>

JSON 格式 

{
    "RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
    "ResourceGroupId": "rg-acfmxazfdgdg****",
    "AllocationId": "eip-25877c70gddh****",
    "EipAddress": "12.xx.xx.78",
    "OrderId": 10
}