1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
将弹性公网IP(简称 EIP)绑定到实例或弹性网卡的指定内网 IP 上。
将 EIP 绑定到实例(ECM)上,其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。
将 EIP 绑定到指定网卡的内网 IP上,内网IP已经绑定了EIP或普通公网IP,则反馈失败。必须先解绑该 EIP,才能再绑定新的。
只有状态为 UNBIND 的 EIP 才能够绑定内网IP。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AssociateAddress。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
EcmRegion | 是 | String | ECM 地域 |
AddressId | 是 | String | 标识 EIP 的唯一 ID。EIP 唯一 ID 形如:eip-11112222。 |
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. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | String | 异步任务TaskId。可以使用DescribeTaskResult接口查询任务状态。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 绑定EIP到实例上
实例主网卡无外网IP条件下,将EIP绑定到实例主网卡
输入示例
https://ecm.tencentcloudapi.com/?Action=AssociateAddress
&AddressId=eip-11112222
&InstanceId=ins-11221122
&EcmRegion=ap-hangzhou-ecm
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": "123",
"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.InternalOperationFailure | 内部操作错误。 |
FailedOperation.InvalidStatus | 当前状态无法执行该操作。 |
FailedOperation.OperationNotAllow | 不允许执行当前操作。 |
FailedOperation.PrivateIpAddressUnavailable | 内网IP状态非可用状态。 |
InvalidParameter | 参数错误。 |
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
InvalidParameter.InvalidParameterConflict | 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvaildEniID | 无效的弹性网卡ID。 |
InvalidParameterValue.InvalidInstanceID | 实例ID不合法。 |
InvalidParameterValue.InvalidPublicParam | 公共参数不合法。 |
InvalidParameterValue.InvalidRegion | ecm region不合法。 |
LimitExceeded.AddressQuotaLimitExceeded | 申请数量超限。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.MissingAssociateEntity | 缺少需关联的实体参数。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.AddressIdNotFound | 未找到相关IP。 |
UnsupportedOperation.AlreadyBindEip | 指定实例已经绑定了EIP。需先解绑当前的EIP才能再次进行绑定操作。 |
UnsupportedOperation.InstanceIdNotFound | 无效实例ID。指定的实例ID不存在。 |
UnsupportedOperation.InstanceIdNotSupported | 不被支持的实例。 |
UnsupportedOperation.InvalidNetworkInterfaceIdNotFound | 指定 NetworkInterfaceId 不存在或指定的PrivateIpAddress不在NetworkInterfaceId上。 |
UnsupportedOperation.InvalidPrivateIpAddressAlreadyBindEip | 指定弹性网卡的指定内网IP已经绑定了EIP,不能重复绑定。 |
UnsupportedOperation.Malformed | 请确认提供的IP地址是否完整。 |
UnsupportedOperation.StatusNotPermit | 当前状态不能进行此操作。 |