Create an IPv6 Gateway with CreateIpv6Gateway to Enable Egress Control - IPv6 Gateway - Alibaba Cloud - IPv6 Gateway

Creates an IPv6 gateway. An IPv6 gateway is used to control IPv6 network traffic for a virtual private cloud (VPC).

Operation description

Before you create an IPv6 gateway, make sure that the target VPC and vSwitch have IPv6 CIDR blocks enabled. You can call DescribeVpcAttribute to query the configuration of a VPC.
Only one IPv6 gateway can be created in a VPC.
CreateIpv6Gateway is an asynchronous operation. After you send a request, the system returns an instance ID but enable IPv6 gateway is not yet created. The system continues to run the startup task in the background. You can call DescribeIpv6GatewayAttribute to query the creation status of enable IPv6 gateway:
- If enable IPv6 gateway is in the Creating state, enable IPv6 gateway is being created.
- If enable IPv6 gateway is in the Created state, enable IPv6 gateway is created.
The CreateIpv6Gateway operation does not support concurrent creation of IPv6 gateways in the same VPC.

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:CreateIpv6Gateway

create

*Ipv6Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv6 gateway. You can call DescribeRegions to query the most recent region list.	cn-huhehaote
VpcId	string	Yes	The ID of the VPC for which you want to enable IPv6 and create the IPv6 gateway.	vpc-123sedrfswd23****
Name	string	No	The name of the IPv6 gateway. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	ipv6GW
Description	string	No	The description of the IPv6 gateway. The description must be 0 to 256 characters in length and cannot start with `http://` or `https://`.	ipv6gatewayforVPC1
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.	0c593ea1-3bea-11e9-b96b-88e9fe637760
ResourceGroupId	string	No	The ID of the resource group to which the IPv6 gateway belongs. For more information about resource groups, see What is a resource group?.	rg-acfmxazb4ph6aiy****
Tag	array<object>	No	The tags of the resource.
	object	No	The tag.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	FinanceJoshua
DryRun	boolean	No

Response elements

Element	Type	Description	Example
	object	The response parameters.
Ipv6GatewayId	string	The ID of the IPv6 gateway.	ipv6gw-hp3y0l3ln89j8cdvf****
ResourceGroupId	string	The ID of the resource group to which the IPv6 gateway belongs.	rg-acfmxazb4ph6aiy****
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC

Examples

Success response

JSON format

{
  "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidVpcId.NotFound	%s
400	IllegalParam.Name	%s
400	IllegalParam.Description	%s
400	IllegalParam.Spec	%s
400	IllegalParam.ChargeType	%s
400	OperationUnsupported.OnlyOneIpv6GatewayInVpc	%s
400	OperationFailed.VpcIpv6Disabled	%s
400	IllegalParam.ResourceGroupId	Invalid ResourceGroupld value.	The specified resource group is invalid or does not exist.
400	MissingParam.vpcId	The parameter vpcId is mandatory.	The vpcId parameter is required.
400	Forbidden.OperateShareResource	You cannot operate shared resources.	Shared resources do not support this operation.
404	InvalidVpcId.NotFound	Specified VPC does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.