1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(AssociateIPv6Address)用于将弹性公网IPv6(简称EIPv6)实例绑定到 CVM 或弹性网卡配置的内网 IPv6 地址上。
- 将 EIPv6 绑定到 CVM 上,其本质是将 EIPv6 绑定到 CVM 弹性网卡所配置的内网 IPv6 地址上。
- 将 EIPv6 绑定到指定网卡的内网 IPv6 时,需确保该内网 IPv6 地址为未绑定状态,才能执行绑定操作。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AssociateIPv6Address。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
IPv6AddressId | 是 | String | 弹性公网IPv6唯一ID,EIPv6 唯一 ID 形如:eipv6-11112222。 示例值:eipv6-nzvwsush |
NetworkInterfaceId | 否 | String | 要绑定的弹性网卡 ID。 弹性网卡 ID 形如:eni-11112222。NetworkInterfaceId 与 InstanceId 不可同时指定。弹性网卡 ID 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的networkInterfaceId获取。 示例值:eni-jyhoxx61 |
PrivateIPv6Address | 否 | String | 要绑定的内网 IPv6。如果指定了 NetworkInterfaceId 则也必须指定 PrivateIPv6Address ,表示将 EIP 绑定到指定弹性网卡的指定内网 IP 上。同时要确保指定的 PrivateIPv6Address 是指定的 NetworkInterfaceId 上的一个内网 IPv6。指定弹性网卡的内网 IPv6 可通过登录控制台查询,也可通过DescribeNetworkInterfaces接口返回值中的Ipv6AddressSet.Address获取。 示例值:fc00:200:300:700:0:9c64:2c95:b711 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 弹性公网IPv6绑定弹性网卡
弹性公网IPv6绑定弹性网卡。
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssociateIPv6Address
<公共请求参数>
{
"IPv6AddressId": "eipv6-3lxpc6sh",
"NetworkInterfaceId": "eni-0c454zph",
"PrivateIPv6Address": "fc00:200:300:700:0:9c64:2c95:b711"
}
输出示例
{
"Response": {
"RequestId": "631011dd-6dfa-41b5-be7c-47bd61d82978"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter | 参数错误。 |
InvalidParameterConflict | 指定的两个参数冲突,不能同时存在。 EIP只能绑定在实例上或指定网卡的指定内网 IP 上。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.AddressIdMalformed | 该地址ID不合法。 |
InvalidParameterValue.AddressIpNotFound | IP地址未找到。 |
InvalidParameterValue.AddressNotApplicable | 该地址不可与此实例申请。 |
InvalidParameterValue.MissingAssociateEntity | 缺少绑定的实例。 |
InvalidParameterValue.NetworkInterfaceInstanceNotSupport | 网卡所绑定实例不支持绑定弹性公网IPv6 |
InvalidParameterValue.NetworkInterfaceNotFound | 未找到网络接口ID,或私有IP地址未在网络接口配置。 |
InvalidPrivateIpAddress.AlreadyBindEip | 指定弹性网卡的指定内网IP已经绑定了EIP,不能重复绑定。 |
MissingParameter | 缺少参数错误。 |
OperationDenied.AddressInArrears | 指定公网IP处于隔离状态。 |
UnsupportedOperation.AddressStatusNotPermit | 该地址状态不支持此操作。 |