1. 接口描述
接口请求域名： vpc.api3.gsesgpucloud.com。
本接口 (AssociateAddress) 用于将弹性公网IP（简称 EIP）绑定到实例或弹性网卡的指定内网 IP 上。
- 将 EIP 绑定到实例（CVM）上，其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。
- 将 EIP 绑定到主网卡的主内网IP上，绑定过程会把其上绑定的普通公网 IP 自动解绑并释放。
- 将 EIP 绑定到指定网卡的内网 IP上（非主网卡的主内网IP），则必须先解绑该 EIP，才能再绑定新的。
- 将 EIP 绑定到NAT网关，请使用接口AssociateNatGatewayAddress
- EIP 如果欠费或被封堵，则不能被绑定。
- 只有状态为 UNBIND 的 EIP 才能够被绑定。
默认接口请求频率限制：10次/秒。
接口更新时间：2022-06-22 16:16:26。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AssociateAddress |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| AddressId | 是 | 否 | String | 标识 EIP 的唯一 ID。EIP 唯一 ID 形如：eip-11112222。示例值： |
| InstanceId | 否 | 否 | String | 要绑定的实例 ID。实例 ID 形如：ins-11112222。可通过登录控制台查询，也可通过 DescribeInstances 接口返回值中的InstanceId获取。示例值： |
| 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. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 示例值： |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidInstanceId.NotFound | 无效实例ID。指定的实例ID不存在。 |
| InvalidAddressId.Blocked | 指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的，需要先进行解封。 |
| InvalidAddressIdState.InArrears | 指定EIP处于欠费状态。 |
| InvalidAddressId.Blocked | 指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的，需要先进行解封。 |
| InvalidAddressId.NotFound | 指定的EIP不存在。 |
| InvalidAddressIdStatus.NotPermit | 指定 EIP 当前状态不能进行绑定操作。只有 EIP 的状态是 UNBIND 时才能进行绑定操作。 |
| InvalidInstance.NotSupported | 不被支持的实例。 |
| InvalidInstanceId.AlreadyBindEip | 指定实例已经绑定了EIP。需先解绑当前的EIP才能再次进行绑定操作。 |
| InvalidNetworkInterfaceId.NotFound | 指定 NetworkInterfaceId 不存在或指定的PrivateIpAddress不在NetworkInterfaceId上。 |
| InvalidParameterConflict | 指定的两个参数冲突，不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。 |
| InvalidPrivateIpAddress.AlreadyBindEip | 指定弹性网卡的指定内网IP已经绑定了EIP，不能重复绑定。 |
| MissingParameter | 参数缺失。请求没有带必选参数。 |
| MissingResourceId | 绑定的实体缺失。InstanceId或NetworkInterfaceId、PrivateIpAddress必须指定一个。 |