AllocateIpv6Address

Invokes the AllocateIpv6Address operation to allocate a free IPv6 address or IPv6 prefix CIDR block. The address is not associated with any resource instance (such as an elastic network interface (ENI) or Network Load Balancer (NLB) instance) and exists as an independent IPv6 address in a virtual private cloud (VPC).

Operation description

Scenarios: After you enable Internet bandwidth for a free IPv6 address, configure an inbound routing rule in the IPv6 gateway route table to direct public IPv6 traffic to an Internet Data Center (IDC) through an Express Connect circuit. This way, IDC resources can provide services over the Internet by using an Alibaba Cloud IPv6 address.

Note

To allocate an IPv6 address to an elastic network interface (ENI) of an ECS instance, invoke the AssignIpv6Addresses operation of ECS.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:AllocateIpv6Address

create

*Ipv6Address

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
VSwitchId	string	Yes	The ID of the vSwitch to which the IPv6 address belongs.	vsw-asdfjlnaue4g****
Ipv6Address	string	No	The IPv6 address to allocate. The specified IPv6 address must be an idle address within the CIDR block of the vSwitch.	2408:XXXX:153:3921:851c:c435:7b12:1c5f
Ipv6AddressName	string	No	The name of the IPv6 address instance. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	ipv6-name
Ipv6AddressDescription	string	No	The description of the IPv6 address instance. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	ipv6-description
AddressType	string	No	The type of the IPv6 address. Valid values: IPv6Address (default): The instance is a single IPv6 address. IPv6Prefix: The instance is an IPv6 CIDR block.	IPv6Address
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see What is a resource group?.	rg-bp67acfmxazb4ph****
Tag	array<object>	No	The list of tags for the resource.
	object	No	The tag of the resource.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. Do not set this parameter to an empty string. A tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`, or contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The value can be an empty string. The tag value can be up to 128 characters in length and cannot start with aliyun or acs:, or contain http:// or https://.	FinanceJoshua
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-0016e04****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the DryRunOperation error code is returned. false (default): performs a dry run and sends the request. If the check succeeds, an HTTP 2xx status code is returned and the operation is performed.	false
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
Ipv6AddressId	string	The instance ID of the IPv6 address.	ipv6-2zen5j4axcp5l5qyy****
Ipv6Address	string	The IPv6 address.	2408:XXXX:153:3921:851c:c435:7b12:1c5f
ResourceGroupId	string	The resource group ID.	rg-acfmxazdjdhd****
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.IPv6AddressAlreadyAllocated	The operation is failed because of the ipv6 address specified was allocated.	The specified IPv6 address is already allocated
400	OperationFailed.AddressNotInVSwitchCidr	The operation is failed because of %s.	The specified IP address is not in the vSwitch CIDR block. Please modify it as described in the API document and try again.
400	IllegalParam.IpAddress	The param of %s is illegal.	The IP address format is invalid. See the API reference and specify a valid IP address.
400	OperationFailed.IPv6Disabled	Operation failed because IPv6 is not enabled for the vSwitch.	The IPv6 feature is disabled.
400	OperationFailed.IpPrefixMustInVSwitchCidrReservation	The specified ip prefix must in reserved segment the VSwitch.	The specified prefix network segment must be within the reserved network segment of the switch
400	Forbidden.OperateShareResource	You cannot operate shared resources.	Shared resources do not support this operation.
400	QuotaExceeded.IPv6PrefixMask	The quota of specifed ipv6 prefix mask is exceeded.	The specified IPv6 prefix mask exceeds the quota.
400	OperationUnsupported.Ipv6Feature	The IPv6 feature is not supported in the region.	This region does not support IPv6.
400	IllegalParam.Ipv6Prefix	The param of Ipv6Prefix is illegal.	The specified input Ipv6Prefix is illegal.
400	OperationFailed.ExistIPv6Used	The operation is failed because of some ipv6 in the ipv6 prefix is already in use.	The operation failed because IPv6 is already in use in the IPv6 prefix
400	OperationUnsupported.UnboundIpv6PrefixFeature	The region does not support creating IPv6 prefix that are not bound to any resources.	This region does not support creating IPv6 prefix CIDR blocks that are not bound to resources.
400	OperationUnsupported.UnboundIpv6Feature	The region does not support creating IPv6 addresses that are not bound to any resources.	The region does not support creating IPv6 address instances that are not bound to resources.
400	OperationUnsupported.FreePrivateIpv6	This operation does not support free private IPv6 addresses.	This operation does not support free private IPv6 addresses.
404	ResourceNotFound.VSwitch	The specified resource of %s is not found.	The specified vSwitch does not exist, please check your input is correct
404	ResourceNotFound.VSwitchCidrReservation	The dependent vswitch cidr reservation is not found.	Dependent resource vSwitchCidrReservation does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.