1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口 (AssociateAddress) 用于将弹性公网IP(简称 EIP)绑定到实例或弹性网卡的指定内网 IP 上。
- 将 EIP 绑定到实例(CVM)上,其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。
- 将 EIP 绑定到主网卡的主内网IP时,如主内网IP已绑定普通公网IP,必须先退还才能绑定EIP。
- 将 EIP 绑定到指定网卡的内网 IP上(非主网卡的主内网IP),则必须先解绑该 EIP,才能再绑定新的。
- 将 EIP 绑定到内网型CLB实例的功能处于内测阶段,如需使用,请提交内测申请。
- 将 EIP 绑定到NAT网关,请使用接口AssociateNatGatewayAddress
- EIP 如果欠费或被封堵,则不能被绑定。
- 只有状态为 UNBIND 的 EIP 才能够被绑定。
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AssociateAddress。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AddressId | 是 | String | 标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222 。示例值:eip-ek0cdz1g |
InstanceId | 否 | String | 要绑定的实例 ID。实例 ID 形如:ins-11112222 、lb-11112222 。可通过登录控制台查询,也可通过 DescribeInstances 接口返回值中的InstanceId 获取。示例值:ins-1bmpb9tu |
NetworkInterfaceId | 否 | String | 要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222 。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId 获取。示例值:eni-jyhoxx61 |
PrivateIpAddress | 否 | String | 要绑定的内网 IP。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIpAddress ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIpAddress 是指定的 NetworkInterfaceId 上的一个内网 IP。指定弹性网卡的内网 IP 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的privateIpAddress 获取。示例值:10.0.0.120 |
EipDirectConnection | 否 | Boolean | 指定绑定时是否设置直通。弹性公网 IP 直通请参见 EIP 直通。取值:True、False,默认值为 False。当绑定 CVM 实例、EKS 弹性集群时,可设定此参数为 True。此参数目前处于内测中,如需使用,请提交 工单申请。 示例值:False |
InstanceRegion | 否 | String | 要绑定的实例所在的地域 示例值:ap-guangzhou |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 示例值:50121411 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 绑定EIP到实例上
绑定EIP到实例上。
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateAddress
<公共请求参数>
{
"InstanceId": "ins-1bmpb9tu",
"AddressId": "eip-ek0cdz1g"
}
输出示例
{
"Response": {
"TaskId": "50121411",
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.AddressEniInfoNotFound | 地址没有弹性网卡信息。 |
FailedOperation.TaskFailed | 任务执行失败。 |
InvalidAccount.NotSupported | 不支持此账户。 |
InvalidAddressId.Blocked | 指定EIP处于被封堵状态。当EIP处于封堵状态的时候是不能够进行绑定操作的,需要先进行解封。 |
InvalidAddressId.NotFound | 指定的EIP不存在。 |
InvalidInstanceId.AlreadyBindEip | 指定实例已经绑定了EIP。需先解绑当前的EIP才能再次进行绑定操作。 |
InvalidInstanceId.NotFound | 无效实例ID。指定的实例ID不存在。 |
InvalidNetworkInterfaceId.NotFound | 指定 NetworkInterfaceId 不存在或指定的PrivateIpAddress不在NetworkInterfaceId上。 |
InvalidParameterConflict | 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。 |
InvalidParameterValue.AddressIdMalformed | 该地址ID不合法。 |
InvalidParameterValue.AddressNotApplicable | 该地址不可与此实例申请。 |
InvalidParameterValue.AddressNotFound | 未找到该地址。 |
InvalidParameterValue.Combination | 非法入参组合。 |
InvalidParameterValue.InstanceDoesNotSupportAnycast | 该实例不支持AnycastEIP。 |
InvalidParameterValue.InstanceHasNoWanIP | 实例不存在公网IP。 |
InvalidParameterValue.InstanceHasWanIP | 该实例已有WanIP。 |
InvalidParameterValue.InstanceIdMalformed | 实例ID错误。 |
InvalidParameterValue.InstanceNoWanIP | 该实例没有WanIP,无法完成请求。 |
InvalidParameterValue.InstanceNormalPublicIpBlocked | 由于该IP被禁用,无法绑定该实例。 |
InvalidParameterValue.InstanceNotMatchAssociateEni | 弹性网卡绑定的实例与地址绑定的实例不一致。 |
InvalidParameterValue.InvalidInstanceInternetChargeType | 该IP只能绑定小时流量后付费和带宽包实例。 |
InvalidParameterValue.InvalidInstanceState | 该实例状态无法完成操作。 |
InvalidParameterValue.LBAlreadyBindEip | 负载均衡实例已经绑定了EIP。 |
InvalidParameterValue.MissingAssociateEntity | 缺少绑定的实例。 |
InvalidParameterValue.NetworkInterfaceNotFound | 未找到网络接口ID,或私有IP地址未在网络接口配置。 |
InvalidParameterValue.ResourceNotSupport | 该资源不支持此操作。 |
InvalidPrivateIpAddress.AlreadyBindEip | 指定弹性网卡的指定内网IP已经绑定了EIP,不能重复绑定。 |
LimitExceeded.InstanceAddressQuota | 实例绑定的弹性IP超过配额。 |
MissingParameter | 缺少参数错误。 |
OperationDenied.AddressInArrears | 指定公网IP处于隔离状态。 |
OperationDenied.MutexTaskRunning | 互斥的任务正在执行。 |
UnsupportedOperation.ActionNotFound | 接口不存在。 |
UnsupportedOperation.AddressIpNotSupportInstance | 绑定此实例的IP地址不支持该操作。 |
UnsupportedOperation.AddressStatusNotPermit | 该地址状态不支持此操作。 |
UnsupportedOperation.IncorrectAddressResourceType | 该种类型地址不支持此操作。 |
UnsupportedOperation.InstanceStateNotSupported | 该地址绑定的实例状态不支持此操作。 |
UnsupportedOperation.InvalidAction | 不支持该操作。 |
UnsupportedOperation.InvalidAddressInternetChargeType | 该地址的网络付费方式不支持此操作。 |
UnsupportedOperation.IspNotSupported | 该ISP不支持此操作。 |