租户端 网络 私有网络（VPC） 弹性公网IP相关接口 AllocateAddresses

AllocateAddresses

最近更新时间: 2024-12-21 13:01:33

1. 接口描述

接口请求域名： vpc.api3.gsesgpucloud.com。

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

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

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

接口更新时间：2022-06-23 10:32:38。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：AllocateAddresses
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
AddressCount 否 否 Int64 EIP数量。默认值：1。
示例值：
InternetServiceProvider 否 否 String EIP线路类型。
<ul style="margin:0">
  • 已开通静态单线IP白名单的用户，可选值：
    • CMCC：中国移动
    • CTCC：中国电信
    • CUCC：中国联通
    注意：仅部分地域支持静态单线IP。

    • 示例值：
    DedicatedClusterId 否 否 Array of String CDC唯一ID。
    示例值：
    InternetChargeType 否 否 String EIP计费方式。
    示例值：
    InternetMaxBandwidthOut 否 否 Int64 EIP出带宽上限，单位：Mbps。
    <ul style="margin:0">
  • 已开通带宽上移白名单的用户，可选值范围取决于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出带宽上限取决于与其绑定的实例的公网出带宽上限，无需传递此参数。

    • 示例值：
    AddressChargePrepaid 否 否 AddressChargePrepaid 计费周期，预付费需要传递。
    示例值：查看
    DealId 否 否 String 订单ID，内部参数。
    示例值：
    AddressType 否 否 String EIP类型。默认值：EIP。
    示例值：
    Zone 否 否 String EIP可用区，用于指定可用区申请EIP。
    示例值：
    VipCluster 否 否 Array of String 指定IP地址申请EIP，每个账户每个月只有三次配额
    示例值：
    Tags 否 否 Array of Tag 需要关联的标签列表。
    示例值：查看
    BandwidthPackageId 否 否 String BGP带宽包唯一ID参数。设定该参数且InternetChargeType为BANDWIDTH_PACKAGE，则表示创建的EIP加入该BGP带宽包并采用带宽包计费
    示例值：

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    AddressQuotaLimitExceeded 账户配额不足，每个账户每个地域下最多可创建 20 个 EIP。
    AddressQuotaLimitExceeded.DailyAllocate 申购次数不足，每个账户每个地域每天申购次数为配额数*2 次。