AllocateIpv6Address - 创建IPv6地址

更新时间:
复制 MD 格式

调用 AllocateIpv6Address 接口分配一个游离的 IPv6 地址或 IPv6 Prefix 地址段。该地址不关联至任何资源实例(如弹性网卡、网络型负载均衡等),仅作为独立的 IPv6 地址存在于 VPC 中。

接口说明

使用场景:为游离 IPv6 地址开通公网带宽后,在 IPv6 网关路由表中配置入方向路由,将公网 IPv6 流量通过专线导向 IDC 侧,实现 IDC 资源通过阿里云 IPv6 地址对外提供服务。

说明

如果需要为 ECS 实例的弹性网卡分配 IPv6 地址,请调用 ECS 的 AssignIpv6Addresses

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

vpc:AllocateIpv6Address

create

*Ipv6Address

acs:vpc:{#regionId}:{#accountId}:ipv6address/*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。

cn-hangzhou

VSwitchId

string

IPv6 地址所在的交换机的 ID。

vsw-asdfjlnaue4g****

Ipv6Address

string

指定要申请的 IPv6 地址。指定的 IPv6 地址必须是在所属交换机的地址段内的空闲地址。

2408:XXXX:153:3921:851c:c435:7b12:1c5f

Ipv6AddressName

string

IPv6 地址的实例名称。

长度为 0~128 个字符,不能以http://https://开头。

ipv6-name

Ipv6AddressDescription

string

IPv6 地址的实例描述。

长度为 0~256 个字符,不能以http://https://开头。

ipv6-description

AddressType

string

IPv6 地址的类型,取值:

  • IPv6Address(默认值):代表当前实例是单个 IPv6 IP。

  • IPv6Prefix:代表当前实例是 IPv6 Cidr。

IPv6Address

ResourceGroupId

string

资源组 ID。关于资源组的更多信息,请参见什么是资源组

rg-bp67acfmxazb4ph****

Tag

array<object>

资源的标签列表。

object

资源的标签。

Key

string

资源的标签键。最多支持输入 20 个标签键。如需传入该值,请勿输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept

Value

string

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。

FinanceJoshua

ClientToken

string

客户端 Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。

02fb3da4-130e-11e9-8e44-0016e04****

DryRun

boolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会查询资源状况。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码 DryRunOperation。

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

false

RegionId

string

地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

Ipv6AddressId

string

IPv6 地址的实例 ID。

ipv6-2zen5j4axcp5l5qyy****

Ipv6Address

string

IPv6 地址。

2408:XXXX:153:3921:851c:c435:7b12:1c5f

ResourceGroupId

string

资源组 ID。

rg-acfmxazdjdhd****

RequestId

string

请求 ID。

54B48E3D-DF70-471B-AA93-08E683A1B45

示例

正常返回示例

JSON格式

{
  "Ipv6AddressId": "ipv6-2zen5j4axcp5l5qyy****",
  "Ipv6Address": "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
  "ResourceGroupId": "rg-acfmxazdjdhd****",
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45"
}

错误码

HTTP status code

错误码

错误信息

描述

400 OperationFailed.IPv6AddressAlreadyAllocated The operation is failed because of the ipv6 address specified was allocated. 指定的IPv6地址已被分配
400 OperationFailed.AddressNotInVSwitchCidr The operation is failed because of %s. 指定的IP地址不在vSwitch的网段内,请按API文档参数说明修改后重试。
400 IllegalParam.IpAddress The param of %s is illegal. 指定的IP地址格式非法,请按API文档参数说明修改后再重试
400 OperationFailed.IPv6Disabled Operation failed because IPv6 is not enabled for the vSwitch. 指定操作失败,因为IPv6功能未打开。
400 OperationFailed.IpPrefixMustInVSwitchCidrReservation The specified ip prefix must in reserved segment the VSwitch. 指定的前缀网段必须位于交换机预留网段内
400 Forbidden.OperateShareResource You cannot operate shared resources. 来自共享的资源不允许操作。
400 QuotaExceeded.IPv6PrefixMask The quota of specifed ipv6 prefix mask is exceeded. 指定的IPv6前缀掩码超出配额。
400 OperationUnsupported.Ipv6Feature The IPv6 feature is not supported in the region. 当前地域不支持Ipv6特性。
400 IllegalParam.Ipv6Prefix The param of Ipv6Prefix is illegal. 指定的入参Ipv6Prefix非法
400 OperationFailed.ExistIPv6Used The operation is failed because of some ipv6 in the ipv6 prefix is already in use. 由于IPv6前缀中存在IPv6已被使用,操作失败
400 OperationUnsupported.UnboundIpv6PrefixFeature The region does not support creating IPv6 prefix that are not bound to any resources. 该地域不支持创建未绑定资源的IPv6前缀网段。
400 OperationUnsupported.UnboundIpv6Feature The region does not support creating IPv6 addresses that are not bound to any resources. 该地域不支持创建未绑定资源的IPv6地址实例。
400 OperationUnsupported.FreePrivateIpv6 This operation does not support free private IPv6 addresses. 当前不支持分配游离态私网IPv6地址。
404 ResourceNotFound.VSwitch The specified resource of %s is not found. 指定的vSwitch不存在,请检查您的输入是否正确
404 ResourceNotFound.VSwitchCidrReservation The dependent vswitch cidr reservation is not found. 依赖资源vSwitchCidrReservation不存在

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情