1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口 (AllocateAddresses) 用于申请一个或多个弹性公网IP(简称 EIP)。
- EIP 是专为动态云计算设计的静态 IP 地址。借助 EIP,您可以快速将 EIP 重新映射到您的另一个实例上,从而屏蔽实例故障。
- 您的 EIP 与腾讯云账户相关联,而不是与某个实例相关联。在您选择显式释放该地址,或欠费超过24小时之前,它会一直与您的腾讯云账户保持关联。
- 一个腾讯云账户在每个地域能申请的 EIP 最大配额有所限制,可参见 EIP 产品简介,上述配额可通过 DescribeAddressQuota 接口获取。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AllocateAddresses。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AddressCount | 否 | Integer | EIP数量。默认值:1。 示例值:1 |
InternetServiceProvider | 否 | String | EIP线路类型。默认值:BGP。
示例值:BGP |
InternetChargeType | 否 | String | EIP计费方式。
示例值:TRAFFIC_POSTPAID_BY_HOUR |
InternetMaxBandwidthOut | 否 | Integer | EIP出带宽上限,单位:Mbps。
示例值:10 |
AddressChargePrepaid | 否 | AddressChargePrepaid | 包月按带宽预付费EIP的计费参数。EIP为包月按带宽预付费时,该参数必传,其余场景不需传递 |
AddressType | 否 | String | EIP类型。默认值:EIP。
示例值:AnycastEIP |
AnycastZone | 否 | String | Anycast发布域。
示例值:ANYCAST_ZONE_A |
ApplicableForCLB | 否 | Boolean | [已废弃] AnycastEIP不再区分是否负载均衡。原参数说明如下: AnycastEIP是否用于绑定负载均衡。
示例值:False |
Tags.N | 否 | Array of Tag | 需要关联的标签列表。 |
BandwidthPackageId | 否 | String | BGP带宽包唯一ID参数。设定该参数且InternetChargeType为BANDWIDTH_PACKAGE,则表示创建的EIP加入该BGP带宽包并采用带宽包计费 示例值:bwp-6jnvlsv4 |
AddressName | 否 | String | EIP名称,用于申请EIP时用户自定义该EIP的个性化名称,默认值:未命名 示例值:test |
DedicatedClusterId | 否 | String | CDC唯一ID 示例值:cluster-gbo27yc4 |
Egress | 否 | String | 网络出口,当前仅支持精品BGP、静态单线,这2种IP 地址类型的指定出口传入,默认值:center_egress1,其它可选值:center_egress2、center_egress3 |
AntiDDoSPackageId | 否 | String | 高防包ID, 申请高防IP时,该字段必传。 |
ClientToken | 否 | String | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。 示例值:123e4567-e89b-12d3-a456-426655440000 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AddressSet | Array of String | 申请到的 EIP 的唯一 ID 列表。 示例值:["eip-m44ku5d2"] |
TaskId | String | 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 示例值:61531428 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建加速IP
需开通Anycast公网加速白名单
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<公共请求参数>
{
"AddressCount": 1,
"AddressType": "AnycastEIP"
}
输出示例
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531428",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
示例2 创建常规IP
创建常规IP。
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<公共请求参数>
{
"AddressCount": 1
}
输出示例
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531421",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
示例3 创建静态单线IP
需开通静态单线IP白名单
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<公共请求参数>
{
"AddressCount": 1,
"InternetServiceProvider": "CTCC"
}
输出示例
{
"Response": {
"AddressSet": [
"eip-m44ku5d2"
],
"TaskId": "61531429",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
示例4 申请EIP失败
幂等请求失败,更新幂等参数。
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AllocateAddresses
<公共请求参数>
{
"ClientToken": "b8fcdf80-248a-4095-bfa3-7f59df1aec"
}
输出示例
{
"Response": {
"Error": {
"Code": "UnsupportedOperation.DeliveryFailed",
"Message": "发货失败,请更新`ClientToken`并重试。"
},
"RequestId": "8e176c15-f087-4816-a270-306cf87229a6"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AddressQuotaLimitExceeded | 账户配额不足,每个腾讯云账户每个地域下最多可创建 20 个 EIP。 |
AddressQuotaLimitExceeded.DailyAllocate | 申购次数不足,每个腾讯云账户每个地域每天申购次数为配额数*2 次。 |
FailedOperation.BalanceInsufficient | 账户余额不足。 |
FailedOperation.InvalidRegion | 不支持的地域。 |
InvalidAccount.NotSupported | 不支持此账户。 |
InvalidAddressId.Blocked | 指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的,需要先进行解封。 |
InvalidParameterConflict | 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。 |
InvalidParameterValue.AddressAttacked | 被攻击的IP地址。 |
InvalidParameterValue.AddressIpNotAvailable | 该IP地址现在不可用。 |
InvalidParameterValue.BandwidthOutOfRange | 带宽超出限制。 |
InvalidParameterValue.BandwidthPackageIdMalformed | 带宽包ID不正确。 |
InvalidParameterValue.BandwidthPackageNotFound | 未查询到该带宽包。 |
InvalidParameterValue.BandwidthTooSmall | 选择带宽低于可允许的最小范围。 |
InvalidParameterValue.Combination | 非法入参组合。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID错误。 |
InvalidParameterValue.InvalidDedicatedClusterId | 传入的DedicatedClusterId有误。 |
InvalidParameterValue.InvalidTag | 该Tag不合法。 |
InvalidParameterValue.MixedAddressIpSetType | 集群类型不同的IP不可在同一请求中。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.ResourceIdMalformed | 资源ID不正确。 |
InvalidParameterValue.ResourceNotSupport | 该资源不支持此操作。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.UnavailableZone | 该可用区不可用。 |
LimitExceeded.BandwidthPackageQuota | 带宽包配额超过限制。 |
LimitExceeded.BandwidthPackageResourceQuota | 当前带宽包加入资源上限。 |
LimitExceeded.MonthlyAddressRecoveryQuota | 每月地址找回配额超过限制。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
ResourceInsufficient | 资源不足。 |
UnauthorizedOperation.AnycastEip | 无权限申请AnycastEip资源。 |
UnauthorizedOperation.InvalidAccount | 未授权的用户。 |
UnsupportedOperation.AccountNotSupported | 不支持的账户。 |
UnsupportedOperation.ActionNotFound | 接口不存在。 |
UnsupportedOperation.BandwidthPackageIdNotSupported | 该带宽包不支持此操作。 |
UnsupportedOperation.DeliveryFailed | 发货失败。 |
UnsupportedOperation.InstanceStateNotSupported | 该地址绑定的实例状态不支持此操作。 |
UnsupportedOperation.InvalidAction | 不支持该操作。 |
UnsupportedOperation.NotSupportedPurchaseCenterEgressResource | 此地域没有上线出口二资源,请到北京/广州/南京购买。 |
UnsupportedOperation.OfflineChargeType | 此产品计费方式已下线,请尝试其他计费方式。 |
UnsupportedOperation.UnsupportedRegion | 暂无法在此国家/地区提供该服务。 |