创建弹性公网IP
最近更新时间: 2024-06-18 14:31:31
1. 接口描述
接口请求域名： vpc.api3.fincloud.tencent.cn。
本接口 (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 | 公共参数，详见产品支持的地域列表(TODO) |
| AddressCount | 否 | 否 | Int64 | EIP数量。默认值：1。 |
| InternetServiceProvider | 否 | 否 | String | EIP线路类型。默认值：BGP。<br><ul style="margin:0"><li>已开通静态单线IP白名单的用户，可选值：<ul><li>CMCC：中国移动</li><br><li>CTCC：中国电信</li><br><li>CUCC：中国联通</li></ul>注意：仅部分地域支持静态单线IP。</li></ul> |
| TgwGroup | 否 | 否 | String | 此参数对外不可见。 内部参数，用于指定集群申请EIP。 |
| ApplySilence | 否 | 否 | Int64 | 此参数对外不可见。 内部参数。 |
| InternetChargeType | 否 | 否 | String | EIP计费方式。 |
| InternetMaxBandwidthOut | 否 | 否 | Int64 | EIP出带宽上限，单位：Mbps。<br><ul style="margin:0"><li>已开通带宽上移白名单的用户，可选值范围取决于EIP计费方式：<ul><li>BANDWIDTH_PACKAGE：1 Mbps 至 1000 Mbps</li><br><li>BANDWIDTH_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps</li><br><li>TRAFFIC_POSTPAID_BY_HOUR：1 Mbps 至 100 Mbps</li></ul>默认值：1 Mbps。</li><br><li>未开通带宽上移白名单的用户，EIP出带宽上限取决于与其绑定的实例的公网出带宽上限，无需传递此参数。</li></ul> |
| AddressChargePrepaid | 否 | 否 | AddressChargePrepaid | 此参数对外不可见。 计费周期，预付费需要传递。 |
| DealId | 否 | 否 | String | 此参数对外不可见。 订单ID，内部参数。 |
| AddressType | 否 | 否 | String | EIP类型。默认值：EIP。 |
| AnycastZone | 否 | 否 | String | Anycast发布域。<br><ul style="margin:0"><li>已开通Anycast公网加速白名单的用户，可选值：<ul><li>ANYCAST_ZONE_GLOBAL：全球发布域（需要额外开通Anycast全球加速白名单）</li><li>ANYCAST_ZONE_OVERSEAS：境外发布域</li><li><b>[已废弃]</b> ANYCAST_ZONE_A：发布域A（已更新为全球发布域）</li><li><b>[已废弃]</b> ANYCAST_ZONE_B：发布域B（已更新为全球发布域）</li></ul>默认值：ANYCAST_ZONE_OVERSEAS。</li></ul> |
| Zone | 否 | 否 | String | 此参数对外不可见。 EIP可用区，用于指定可用区申请EIP。 |
| VipCluster | 否 | 否 | Array of String | 此参数对外不可见。 指定IP地址申请EIP，每个账户每个月只有三次配额 |
| VipSet | 否 | 否 | Array of String | 此参数对外不可见。 [Deprecated] 该字段无实际功能，废弃 |
| ApplicableForCLB | 否 | 否 | Bool | <b>[已废弃]</b> AnycastEIP不再区分是否负载均衡。原参数说明如下：<br>AnycastEIP是否用于绑定负载均衡。<br><ul style="margin:0"><li>已开通Anycast公网加速白名单的用户，可选值：<ul><li>TRUE：AnycastEIP可绑定对象为负载均衡</li><br><li>FALSE：AnycastEIP可绑定对象为云服务器、NAT网关、高可用虚拟IP等</li></ul>默认值：FALSE。</li></ul> |
| Tags | 否 | 否 | Array of Tag | 需要关联的标签列表。 |
| SetId | 否 | 否 | Int64 | 此参数对外不可见。 TGW集群ID，用于指定集群ID申请弹性公网IP。注意，anycast EIP不支持指定集群ID申请，静态单线EIP指定集群ID申请时，InternetServiceProvider参数必须和集群ID的运营商属性一致。 |
| Restrictive | 否 | 否 | Bool | 此参数对外不可见。 是否是本地带宽IP。默认值：否 |
| BandwidthPackageId | 否 | 否 | String | BGP带宽包唯一ID参数。设定该参数且InternetChargeType为BANDWIDTH_PACKAGE，则表示创建的EIP加入该BGP带宽包并采用带宽包计费 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AddressSet | String | 此参数对外不可见。 申请到的 EIP 的唯一 ID 列表。 |
| TaskId | String | 此参数对外不可见。 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| AddressQuotaLimitExceeded | |
| AddressQuotaLimitExceeded.DailyAllocate | |
| AddressQuotaLimitExceeded.DailyAllocate |