全部产品
Search
文档中心

弹性公网 IP:AllocateEipSegmentAddress - 申请连续EIP

更新时间:May 31, 2024

连续EIP是一组按序排列的弹性公网IP地址,您可以在进行网络设计时,为需要连续公网IP地址的云资源批量申请和使用这些IP地址。您可以通过调用AllocateEipSegmentAddress接口申请连续EIP。

接口说明

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

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

  • 当连续 EIP 组处于 Allocated 状态时,表示连续 EIP 组已分配完成。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:AllocateEipSegmentAddressWrite
  • SegmentAddress
    acs:vpc:{#regionId}:{#accountId}:eip/*

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-001****
Bandwidthstring

EIP 的带宽峰值。单位:Mbps。

  • InternetChargeType 取值为 PayByBandwidth 时,Bandwidth 取值范围为 1~500

  • InternetChargeType 取值为 PayByTraffic 时,Bandwidth 取值范围为 1~200

默认值为 5 Mbps。

5
RegionIdstring

连续 EIP 所在的地域 ID。

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

cn-hangzhou
EipMaskstring

连续 EIP 的掩码,取值:

  • 28:单次调用,系统将分配 16 个连续 EIP。

  • 27:单次调用,系统将分配 32 个连续 EIP。

  • 26:单次调用,系统将分配 64 个连续 EIP。

  • 25:单次调用,系统将分配 128 个连续 EIP。

  • 24:单次调用,系统将分配 256 个连续 EIP。

说明 由于 IP 地址保留,实际申请到的连续 EIP 可能缺少 1、3 或者 4 个 EIP。
28
Netmodestring

网络类型,仅取值:public,表示公网。

public
InternetChargeTypestring

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

  • PayByBandwidth(默认值):按固定带宽计费。

  • PayByTraffic:按使用流量计费。

PayByBandwidth
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4ph****
Ispstring

线路类型。取值:

  • 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

BGP
Zonestring

连续 EIP 组的可用区。

cn-hangzhou-a

返回参数

名称类型描述示例值
object

返回信息列表。

RequestIdstring

请求 ID。

F7A6301A-64BA-41EC-8284-8F4838C15D1F
EipSegmentInstanceIdstring

连续 EIP 组的实例 ID。

eipsg-2zett8ba055tbsxme****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400COMMODITY_NO_EXISTcommodity is not exist-
400QuotaExceeded.EipElastic IP address quota exceeded-
400InvalidParameterSpecified value of "InternetChargeType" is not valid-
400InvalidParameterSpecified value of "Bandwidth" is not valid.该带宽不合法。
400InsufficientBalanceYour account does not have enough balance.账户余额不足,请先充值再操作。
400QuotaExceeded.EipElastic IP address quota exceeded.弹性公网IP的个数超过额度限制,如果您有更多额度的需求,建议您考虑使用NAT网关。
400ReserveIpFailReserve eip failed.EIP预留失败。
400InvalidRegion.NotSupportThe specified region does not support.该 RegionId 不支持此操作。
400InvalidBandwidth.MalformedThe specified Bandwidth is invalid.-
400INSTANCE_TYPE_NOT_SUPPORTThe instance type is invalid.-
400QueryParameter.Illegalquery parameter illegal-
400TokenVerfiy.Failedtoken verify failed.-
400OrderFailedThe Account failed to create order.-
400QuotaExceeded.LargeSpecEipElastic IP address with large spec quota exceeded.-
400InvalidResourceGroupIdThe specified ResourceGroupId does not exist.资源组ID不存在。
400PAYFOR.CREDIT_PAY_INSUFFICIENT_BALANCEYour account does not have enough balance.-
400SYSTEM.SALE_VALIDATE_UNEXPECTED_ERRORYou have arrears and do not meet the purchase conditions.-
400Trade_Sync_Create_Sub_ERRORSyncOrderToSub error.-
400InvalidComponent.EipBandwidthMaxThe eip_bandwidth_max component is invalid.-
400OperationFailed.RiskControlRisk control check failed.我们检测到您的付款方式存在安全风险。请通过电子邮件或控制台消息中的链接继续验证,并在验证后重新提交订单。
400OperationFailed.SaleValidateValidate sale condition with subArticle failed.使用子项目验证销售条件失败。
400IllegalParam.OrderParamComponentProduct order param has invalid component.-
400OperationFailed.SaleExpressionGet the sales expression exception attached to the item.-
400OperationFailed.CompleteUserInfoComplete user info failed.-
400OperationFailed.QueryPriceQuery price failed when create order.创建订单时查询价格失败。
400OperationFailed.InsufficientEIPEip resource is not enough.-
400OperationFailed.InvokeInnerApiFailed to invoke inner api.-
400OperationFailed.AccountMoneyInvalidAccount money is invalid.-
400OperationFailed.QueryCredtiInfoFailed to query credit info.-
400FrequentPurchase.EIPeip frequent purchase-
400OperationFailed.QueryUserLabelFailed to query user label info.-
400PAY.INSUFFICIENT_BALANCEYour account does not have enough balance.-
400ORDER.QUANTITY_INVALIDUser quota has exceeded the limit.您当前保有的EIP数量已达上限,可前往配额管理提升EIP数量配额
400PAY.MAYI_WITHHOLDING_AGREEMENT_ILLEGALUser withhoding argeement is illegal.-
400OperationFailed.ChargeTypeInvalidOperation failed because hybrid netmode do not support PayByTraffic.-
400IllegalParam.EipMaskEipMask is illegal.-
400IllegalParam.NameName is illegal.-
400IllegalParam.DescriptionDescription is illegal.-
400InstanceExist.EipSegmentThe eipSegment instance already exists.-
400OperationFailed.QuotaExceedOperation failed because over threshold bandwidth quota exceed.-
400OperationFailed.FrequentPurchaseOperation failed because eip frequent purchase.-
400OperationFailed.AllocateEipSegmentOperation failed because eip segment is out of stock.-
400OperationFailed.CreateOrderFailedOperation failed because create order failed.-
400MissingParam.BandwidthThe parameter Bandwidth is mandatory when allocate hybrid EipSegment.-
400OperationFailed.EipQuotaExceedOperation failed because eip quota exceed.-
400OrderError.EIPThe Account failed to create order.下单失败
400OperationConflictRequest was denied due to conflict with a previous request.请求冲突,请稍后重试。
400ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
400UnsupportedFeature.AllocateEipAddressWithZoneThe feature of AllocateEipAddressWithZone is not supported.当前地域不支持指定Zone创建实例
400IllegalParam.ZoneThe specified zone is invalid.参数Zone非法
404InvalidRegionId.NotFoundSpecified value of "RegionId" is not supported.指定的 RegionId 不存在,请您检查此产品在该地域是否可用。
404InvalidRegionId.NotFoundThe RegionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
404FUWU_BIZ_COMMODITY_VERIFY_FAIL????????, ????????PD.-
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:500
2023-07-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:404
    删除错误码:500
2023-05-22OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Zone
2023-03-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
出参OpenAPI 返回结构发生变更