操作指南

API文档

填写文档满意度调查问卷,赢取缤纷好礼> HOT

分配IPv6地址

最近更新时间:2022-08-16 06:51:49

我的收藏

1. 接口描述

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

本接口(AssignIpv6Addresses)用于弹性网卡申请IPv6地址。

本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的RequestId轮询DescribeVpcTaskResult接口。

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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必填一个。
Ipv6AddressCount Integer 自动分配IPv6地址个数,内网IP地址个数总和不能超过配数。与入参Ipv6Addresses合并计算配额。与Ipv6Addresses必填一个。

3. 输出参数

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

4. 示例

示例1 分配指定IPv6地址

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssignIpv6Addresses
<公共请求参数>

{
    "Ipv6Addresses": [
        {
            "Description": "test2",
            "Primary": "false",
            "Address": "3402:4e00:20:1202::2"
        },
        {
            "Description": "test1",
            "Primary": "false",
            "Address": "3402:4e00:20:1202::1"
        }
    ],
    "NetworkInterfaceId": "eni-5u5biujl"
}

输出示例

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

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

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AssignIpv6Addresses
<公共请求参数>

{
    "NetworkInterfaceId": "eni-5u5biujl",
    "Ipv6AddressCount": "2"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.Range 参数值不在指定范围。
InvalidParameterValue.Reserved 参数值是一个系统保留对象。
LimitExceeded 超过配额限制。
LimitExceeded.Address 分配IP地址数量达到上限。
MissingParameter 缺少参数错误。
ResourceInUse 资源被占用。
ResourceInUse.Address 指定IP地址已经在使用中。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InvalidState 资源状态不合法。
UnsupportedOperation.MutexOperationTaskRunning 资源互斥操作任务正在执行。
UnsupportedOperation.UnassignCidrBlock 未分配IPv6网段。
目录