All Products
Search
Document Center

Virtual Private Cloud:CreateIpv6Gateway

Last Updated:Mar 04, 2024

IPv6 gateways are used to control the IPv6 traffic of virtual private clouds (VPCs). You can call the CreateIpv6Gateway operation to create IPv6 gateways.

Operation description

  • CreateIpv6Gateway is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeIpv6GatewayAttribute operation to query the status of the task.

    • If the IPv6 gateway is in the Creating state, the IPv6 gateway is being created.
    • If the IPv6 gateway is in the Created state, the IPv6 gateway is created.
  • You cannot repeatedly call the CreateIpv6Gateway operation within a specific time period.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:CreateIpv6GatewayWrite
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
VpcIdstringYes

The ID of the VPC in which you want to create the IPv6 gateway.

vpc-123sedrfswd23****
NamestringNo

The name of the IPv6 gateway.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

ipv6GW
DescriptionstringNo

The description of the IPv6 gateway.

The description must be 2 to 256 characters in length and cannot start with http:// or https://.

ipv6gatewayforVPC1
ClientTokenstringNo

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 token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
0c593ea1-3bea-11e9-b96b-88e9fe637760
ResourceGroupIdstringNo

The ID of the resource group to which the IPv6 gateway belongs.

rg-acfmxazb4ph6aiy****
Tagobject []No

The tags.

KeystringNo

The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

FinanceDept
ValuestringNo

The tag value. You can specify at most 20 tag values. The tag value can be an empty string.

The tag value can be up to 128 characters in length, and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

FinanceJoshua

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Ipv6GatewayIdstring

The ID of the IPv6 gateway.

ipv6gw-hp3y0l3ln89j8cdvf****
ResourceGroupIdstring

The ID of the resource group to which the IPv6 gateway belongs.

rg-acfmxazb4ph6aiy****
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidVpcId.NotFound%s-
400IllegalParam.Name%s-
400IllegalParam.Description%s-
400IllegalParam.Spec%s-
400IllegalParam.ChargeType%s-
400OperationUnsupported.OnlyOneIpv6GatewayInVpc%s-
400OperationFailed.VpcIpv6Disabled%s-
400OperationFailed.UnpaidBillsExistThe account has unpaid bills. Please pay your overdue bill first.This account has unpaid orders.
400OperationFailed.InformationIncompleteYour information is incomplete.The information that you entered is incomplete.
400OperationFailed.NoPaymentMethodNo payment method is specified for your account.-
400IllegalParam.ResourceGroupIdInvalid ResourceGroupld value.The specified resource group is invalid or does not exist.
400MissingParam.vpcIdThe parameter vpcId is mandatory.The vpcId parameter is required.
404InvalidRegionId.NotFoundThe specified RegionId does not exist in our records.The specified region ID does not exist.
404InvalidVpcId.NotFoundSpecified VPC does not exist.The specified VPC does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-07-05The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Tag