分配IPv6地址

最近更新时间:2019-05-09 21:58:31

1. 接口描述

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

本接口(AssignIpv6Addresses)用于弹性网卡申请IPv6地址。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的RequestId轮询QueryTask接口。

  • 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制
  • 可以指定IPv6地址申请,地址类型不能为主IPIPv6地址暂时只支持作为辅助IP
  • 地址必须要在弹性网卡所在子网内,而且不能被占用。
  • 在弹性网卡上申请一个到多个辅助IPv6地址,接口会在弹性网卡所在子网段内返回指定数量的辅助IPv6地址。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AssignIpv6Addresses
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
NetworkInterfaceId String 弹性网卡实例ID,形如:eni-m6dyj72l
Ipv6Addresses.N Array of Ipv6Address 指定的IPv6地址列表,单次最多指定10个。与入参Ipv6AddressCount合并计算配额。
Ipv6AddressCount Integer 自动分配IPv6地址个数,内网IP地址个数总和不能超过配数。与入参Ipv6Addresses合并计算配额。

3. 输出参数

参数名称 类型 描述
Ipv6AddressSet Array of Ipv6Address 分配给弹性网卡的IPv6地址列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 分配指定IPv6地址

输入示例

https://vpc.tencentcloudapi.com/?Action=AssignIpv6Addresses
&NetworkInterfaceId=eni-5u5biujl
&Ipv6Addresses.0.Address=3402:4e00:20:1202::1
&Ipv6Addresses.0.Primary=false
&Ipv6Addresses.0.Description=test1
&Ipv6Addresses.1.Address=3402:4e00:20:1202::2
&Ipv6Addresses.1.Primary=false
&Ipv6Addresses.1.Description=test2
&<公共请求参数>

输出示例

{
  "Response": {
    "Ipv6AddressSet": [
      {
        "Address": "3402:4e00:20:1202::1",
        "AddressId": "",
        "Primary": false,
        "PublicIpAddress": "3402:4e00:20:1202::1",
        "Description": "test1",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      },
      {
        "Address": "3402:4e00:20:1202::2",
        "AddressId": "",
        "Primary": false,
        "PublicIpAddress": "3402:4e00:20:1202::2",
        "Description": "test2",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      }
    ],
    "RequestId": "4a8d6fc0-bc48-4394-b1f7-2818a217359a"
  }
}

示例2 按个数自动分配IPv6地址

输入示例

https://vpc.tencentcloudapi.com/?Action=AssignIpv6Addresses
&NetworkInterfaceId=eni-5u5biujl
&Ipv6AddressCount=2
&<公共请求参数>

输出示例

{
  "Response": {
    "Ipv6AddressSet": [
      {
        "Address": "3402:4e00:20:1202:0:8d05:c272:f514",
        "AddressId": "",
        "Primary": false,
        "PublicIpAddress": "3402:4e00:20:1202:0:8d05:c272:f514",
        "Description": "",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      },
      {
        "Address": "3402:4e00:20:1202:0:8d05:c272:f559",
        "AddressId": "",
        "Primary": false,
        "PublicIpAddress": "3402:4e00:20:1202:0:8d05:c272:f559",
        "Description": "",
        "IsWanIpBlocked": false,
        "State": "PENDING"
      }
    ],
    "RequestId": "4a8d6fc0-bc48-4394-b1f7-2818a217359a"
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数值不合法。
LimitExceeded.Address 分配IP地址数量达到上限。
MissingParameter 参数缺失。请求没有带必选参数。
ResourceInUse.Address 指定IP地址已经在使用中。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.MutexOperationTaskRunning 资源互斥操作任务正在执行。
UnsupportedOperation.UnassignCidrBlock 未分配IPv6网段。