调用AllocateEipAddressPro接口申请指定的弹性公网IP(Elastic IP Address,简称EIP)。

调试

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

请求参数

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

系统规定参数。取值:AllocateEipAddressPro

RegionId String cn-hangzhou

要指定申请的EIP所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

IpAddress String 192.0.XX.XX

要指定申请的EIP的IP地址。

IpAddressInstanceId参数仅需传入一个,如果都不传,系统会随机申请EIP。

InstanceId String eip-25877c70gddh****

要指定申请的EIP的实例ID。

IpAddressInstanceId参数仅需传入一个,如果都不传,系统会随机申请EIP。

Bandwidth String 5

要指定申请的EIP的带宽峰值,单位:Mbps。

  • InstanceChargeType取值为PostPaid,且InternetChargeType取值为PayByBandwidth时,Bandwidth取值范围为1~500
  • InstanceChargeType取值为PostPaid,且InternetChargeType取值为PayByTraffic时,Bandwidth取值范围为1~200
  • InstanceChargeType取值为PrePaid时,Bandwidth取值范围为1~1000

默认值:5 Mbps。

Period Integer 1

购买时长。

  • PricingCycle取值Month时,Period取值范围为1~9
  • PricingCycle取值Year时,Period取值范围为1~3

如果InstanceChargeType参数的值为PrePaid时,该参数必选。

如果InstanceChargeType参数的值为PostPaid时,该参数不填。

ISP String BGP

线路类型。取值:

  • BGP(默认值):BGP(多线)线路。目前全部地域都支持BGP(多线)线路EIP。
  • BGP_PRO:BGP(多线)_精品线路。目前仅中国香港、新加坡、马来西亚(吉隆坡)、菲律宾(马尼拉)、印度尼西亚(雅加达)和泰国(曼谷)地域支持BGP(多线)_精品线路EIP。

关于BGP(多线)线路和BGP(多线)_精品线路的更多信息,请参见EIP线路类型

  • 如果您是单线带宽的白名单用户,您还可以选择以下类型:
    • ChinaTelecom:中国电信
    • ChinaUnicom:中国联通
    • ChinaMobile:中国移动
    • ChinaTelecom_L2:中国电信L2
    • ChinaUnicom_L2:中国联通L2
    • ChinaMobile_L2:中国移动L2
  • 如果您是杭州金融云用户,该字段必填,取值:BGP_FinanceCloud
Netmode String public

网络类型,仅取值为public(默认值),表示公网。

AutoPay Boolean true

是否自动付费,取值:

  • 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可取值PayByBandwidthPayByTraffic

InternetChargeType String PayByBandwidth

要指定申请的EIP的计量方式,取值:

  • PayByBandwidth(默认值):按带宽计费。
  • PayByTraffic:按流量计费。

InstanceChargeType取值为PrePaid时,InternetChargeType必须取值PayByBandwidth

InstanceChargeType取值为PostPaid时,InternetChargeType可取值PayByBandwidthPayByTraffic

ResourceGroupId String rg-resourcegroup****

要指定申请的EIP所属的资源组ID。

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe6****

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的 RequestId作为 ClientToken标识。每次API请求的 RequestId可能不一样。
SecurityProtectionTypes.N String AntiDDoS_Enhanced

安全防护级别。

  • 配置为空时,默认为DDoS防护(基础版)。
  • 配置为AntiDDoS_Enhanced时,表示DDoS防护(增强版)。

您最多可以为10个EIP设置安全防护级别。

PublicIpAddressPoolId String pippool-2vc0kxcedhquybdsz****

IP地址池ID。

EIP将从该IP地址池中分配。

IP地址池功能默认不开放。如需使用,请在配额中心申请IP地址池功能权益配额。具体操作,请参见通过配额中心提升配额

返回数据

名称 类型 示例值 描述
RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

请求ID。

OrderId Long 20190000

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

ResourceGroupId String rg-resourcegroup****

资源组ID。

EipAddress String 192.0.XX.XX

您指定申请的EIP被分配到的IP地址。

AllocationId String eip-25877c70gddh****

EIP的ID。

示例

请求示例

http(s)://[Endpoint]/?Action=AllocateEipAddressPro
&RegionId=cn-hangzhou
&IpAddress=192.0.XX.XX
&InstanceId=eip-25877c70gddh****
&Bandwidth=5
&Period=1
&ISP=BGP
&Netmode=public
&AutoPay=true
&PricingCycle=Month
&InstanceChargeType=PostPaid
&InternetChargeType=PayByBandwidth
&ResourceGroupId=rg-resourcegroup****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe6****
&SecurityProtectionTypes=["AntiDDoS_Enhanced"]
&PublicIpAddressPoolId=pippool-2vc0kxcedhquybdsz****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<AllocateEipAddressProResponse>
    <RequestId>4EC47282-1B74-4534-BD0E-403F3EE64CAF</RequestId>
    <OrderId>20190000</OrderId>
    <ResourceGroupId>rg-resourcegroup****</ResourceGroupId>
    <EipAddress>192.0.XX.XX</EipAddress>
    <AllocationId>eip-25877c70gddh****</AllocationId>
</AllocateEipAddressProResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4EC47282-1B74-4534-BD0E-403F3EE64CAF",
  "OrderId" : 20190000,
  "ResourceGroupId" : "rg-resourcegroup****",
  "EipAddress" : "192.0.XX.XX",
  "AllocationId" : "eip-25877c70gddh****"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParameter Specified value of "Bandwidth" is not valid. 该带宽不合法。
400 InsufficientBalance Your account does not have enough balance. 账户余额不足,请先充值再操作。
400 QuotaExceeded.Eip Elastic IP address quota exceeded. 弹性公网IP的个数超过额度限制,如果您有更多额度的需求,建议您考虑使用NAT网关。
400 ReserveIpFail Reserve eip failed. EIP预留失败。
400 InvalidRegion.NotSupport The specified region does not support. 该 RegionId 不支持此操作。
400 InvalidResourceGroupId The specified ResourceGroupId does not exist. 资源组ID不存在。
400 OperationFailed.AllocateUnfamiliarIp The operation failed because only IP addresses used within the last seven days can be allocated. 指定EIP申请只允许申请7天内使用过的IP
400 OrderError.EIP The Account failed to create order. 下单失败
400 IncorrectStatus.PublicIpAddressPool The status of PublicIpAddressPool is incorrect. 地址池实例未处于稳态,不允许分配EIP。
403 Forbbiden User not authorized to operate on the specified resource. 您没有权限操作该资源,请您申请操作权限后再试。
500 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误

访问错误中心查看更多错误码。