调用AllocateEipSegmentAddress接口申请连续EIP。

使用说明

AllocateEipSegmentAddress接口属于异步接口,即系统会先返回一个连续EIP组的实例ID,但该连续EIP组并未创建完成,系统后台的创建任务仍在进行。您可以调用DescribeEipSegment查询连续EIP组的状态。

  • 当连续EIP组处于Allocating状态时,表示连续EIP组分配中,在该状态下,您只能执行查询操作,不能执行其他操作。
  • 当连续EIP组处于Allocated状态时,表示连续EIP组已分配完成。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
ClientToken String 02fb3da4-130e-11e9-8e44-001****

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

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

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

系统规定参数。取值:AllocateEipSegmentAddress

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。

RegionId String cn-hangzhou

连续EIP所在的地域ID。

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

EipMask String 28

连续EIP的掩码,取值:

  • 28:单次调用,系统将分配16个连续EIP。
  • 27:单次调用,系统将分配32个连续EIP。
  • 26:单次调用,系统将分配64个连续EIP。
  • 25:单次调用,系统将分配128个连续EIP。
  • 24:单次调用,系统将分配256个连续EIP。
说明 由于IP地址保留,实际申请到的连续EIP可能缺少1、3或者4个EIP。
Netmode String public

网络类型,取值:

  • public(默认值):公网。连续EIP和云资源绑定后,云资源可以通过EIP与公网通信。
  • hybrid:混合云。连续EIP和云资源绑定后,云资源可以通过EIP进行混合云通信。
说明 仅具有混合云白名单的用户支持选择混合云类型,如需使用,请联系您的客户经理。
InternetChargeType String PayByBandwidth

连续EIP的计费方式,取值:

  • PayByBandwidth(默认值):按固定带宽计费。
  • PayByTraffic:按使用流量计费。
说明 如果Netmode取值为hybrid时,InternetChargeType仅支持取值为PayByBandwidth
ResourceGroupId String rg-bp67acfmxazb4ph****

资源组ID。

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

返回数据

名称 类型 示例值 描述
RequestId String F7A6301A-64BA-41EC-8284-8F4838C15D1F

请求ID。

OrderId Long 2022****

订单ID。

EipSegmentInstanceId String eipsg-2zett8ba055tbsxme****

连续EIP组的实例ID。

示例

请求示例

http(s)://[Endpoint]/?ClientToken=02fb3da4-130e-11e9-8e44-001****
&Action=AllocateEipSegmentAddress
&Bandwidth=5
&RegionId=cn-hangzhou
&EipMask=28
&Netmode=public
&InternetChargeType=PayByBandwidth
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Isp=BGP
&公共请求参数

正常返回示例

XML格式

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

<AllocateEipSegmentAddressResponse>
    <RequestId>F7A6301A-64BA-41EC-8284-8F4838C15D1F	</RequestId>
    <EipSegmentInstanceId>eipsg-2zett8ba055tbsxme****</EipSegmentInstanceId>
</AllocateEipSegmentAddressResponse>

JSON格式

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

{
  "RequestId" : "F7A6301A-64BA-41EC-8284-8F4838C15D1F\t",
  "EipSegmentInstanceId" : "eipsg-2zett8ba055tbsxme****"
}

错误码

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 ORDER.QUANTITY_INVALID User quota has exceeded the limit. 您当前保有的EIP数量已达上限,可前往配额管理提升EIP数量配额
400 OrderError.EIP The Account failed to create order. 下单失败
403 Forbbiden User not authorized to operate on the specified resource. 您没有权限操作该资源,请您申请操作权限后再试。
409 OperationConflict Request was denied due to conflict with a previos request. 请求冲突,请稍后重试。

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