绑定弹性公网IP

最近更新时间:2018-10-26 15:01:33

1. 接口描述

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

本接口 (AssociateAddress) 用于将弹性公网IP(简称 EIP)绑定到实例或弹性网卡的指定内网 IP 上。

  • 将 EIP 绑定到实例上,其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。
  • 将 EIP 绑定到主网卡的主内网IP上,绑定过程会把其上绑定的普通公网 IP 自动解绑并释放。
  • 如果指定网卡的内网 IP 已经绑定了 EIP,则必须先解绑该 EIP,才能再绑定新的。
  • EIP 如果欠费或被封堵,则不能被绑定。
  • 只有状态为 UNBIND 的 EIP 才能够被绑定。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssociateAddress
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
AddressId String 标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222
InstanceId String 要绑定的实例 ID。实例 ID 形如:ins-11112222。可通过登录控制台查询,也可通过 DescribeInstances 接口返回值中的InstanceId获取。
NetworkInterfaceId String 要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222NetworkInterfaceIdInstanceId 不可同时指定。弹性网卡 ID 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。
PrivateIpAddress String 要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress获取。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 绑定EIP到实例上

输入示例

https://vpc.tencentcloudapi.com/?Action=AssociateAddress
&AddressId=eip-ek0cdz1g
&InstanceId=ins-1bmpb9tu
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidAddressId.Blocked 指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的,需要先进行解封。
InvalidAddressId.NotFound 指定的EIP不存在。
InvalidAddressIdState.InArrears 指定EIP处于欠费状态。
InvalidAddressIdStatus.NotPermit 指定 EIP 当前状态不能进行绑定操作。只有 EIP 的状态是 UNBIND 时才能进行绑定操作。
InvalidInstance.NotSupported 不被支持的实例。
InvalidInstanceId.AlreadyBindEip 指定实例已经绑定了EIP。需先解绑当前的EIP才能再次进行绑定操作。
InvalidInstanceId.NotFound 无效实例ID。指定的实例ID不存在。
InvalidNetworkInterfaceId.NotFound 指定 NetworkInterfaceId 不存在或指定的PrivateIpAddress不在NetworkInterfaceId上。
InvalidParameterConflict 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。
InvalidPrivateIpAddress.AlreadyBindEip 指定弹性网卡的指定内网IP已经绑定了EIP,不能重复绑定。
MissingParameter 参数缺失。请求没有带必选参数。
MissingResourceId 绑定的实体缺失。InstanceId或NetworkInterfaceId、PrivateIpAddress必须指定一个。