创建弹性公网IP

最近更新时间:2024-03-12 01:29:14

我的收藏

1. 接口描述

接口请求域名: ecm.tencentcloudapi.com 。

申请一个或多个弹性公网IP(简称 EIP)

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AllocateAddresses。
Version String 公共参数,本接口取值:2019-07-19。
Region String 公共参数,本接口不需要传递此参数。
EcmRegion String ECM 地域
AddressCount Integer EIP数量。默认值:1。
InternetServiceProvider String CMCC:中国移动
CTCC:中国电信
CUCC:中国联通
InternetMaxBandwidthOut Integer 1 Mbps 至 5000 Mbps,默认值:1 Mbps。
Tags.N Array of Tag 需要关联的标签列表。
InstanceId String 要绑定的实例 ID。
NetworkInterfaceId String 要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。
PrivateIpAddress String 要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。

3. 输出参数

参数名称 类型 描述
AddressSet Array of String 申请到的 EIP 的唯一 ID 列表。
注意:此字段可能返回 null,表示取不到有效值。
TaskId String 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建EIP

输入示例

https://ecm.tencentcloudapi.com/?Action=AllocateAddresses
&AddressCount=1
&InternetServiceProvider=CTCC
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>

输出示例

{
    "Response": {
        "AddressSet": [
            "eip-11112222"
        ],
        "TaskId": "123",
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InternalOperationFailure 内部操作错误。
FailedOperation.InvalidStatus 当前状态无法执行该操作。
FailedOperation.OperationNotAllow 不允许执行当前操作。
FailedOperation.PrivateIpAddressBinded 该内网IP已经绑定了弹性IP。
FailedOperation.PrivateIpAddressUnavailable 内网IP状态非可用状态。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidDataFormat 数据格式不正确。
InvalidParameter.InvalidParameterConflict 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.AddressQuotaLimitExceeded 申请数量超限。
InvalidParameterValue.InvalidAddressCount 当同步绑定弹性网卡时,一次只能申请单个弹性IP。
InvalidParameterValue.InvalidBandwidth 带宽大小不合法。
InvalidParameterValue.InvalidPublicParam 公共参数不合法。
InvalidParameterValue.InvalidRegion ecm region不合法。
InvalidParameterValue.ParameterValueTooLarge 参数值超出限制。
LimitExceeded 超过配额限制。
LimitExceeded.AddressQuotaLimitExceeded 申请数量超限。
LimitExceeded.AddressQuotaLimitExceededDailyAllocate 申购次数不足,每个腾讯云账户每个地域每天申购次数为配额数*2 次。
MissingParameter.MissingPrivateIpAddress 缺少私有IP地址。
ResourceInsufficient.IPQuotaNotEnough IP资源不足。
ResourceNotFound 资源不存在。
ResourceNotFound.InstanceNotExist 实例不合法。
UnauthorizedOperation.ForbiddenOperation 没有权限进行该操作。
UnsupportedOperation.InvalidPrivateIpAddressAlreadyBindEip 指定弹性网卡的指定内网IP已经绑定了EIP,不能重复绑定。