Use DeleteIpv6Gateway to delete an IPv6 gateway - Virtual Private Cloud - Alibaba Cloud - Virtual Private Cloud

Deletes an IPv6 gateway.

Operation description

Before you delete an IPv6 gateway, delete the IPv6 egress-only rules first. For more information, see DeleteIpv6EgressOnlyRule.

The DeleteIpv6Gateway operation is asynchronous. After a request is sent, the system returns a request ID. However, the IPv6 gateway is not yet deleted. The deletion task runs in the background. You can call DescribeIpv6GatewayAttribute to query the deletion status of the IPv6 gateway:
- If the IPv6 gateway is in the Deleting state, the IPv6 gateway is being deleted.
- If the IPv6 gateway cannot be found, the IPv6 gateway is deleted.
The DeleteIpv6Gateway operation does not support concurrent deletion of the same IPv6 gateway.

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

delete

*Ipv6Gateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote
Ipv6GatewayId	string	Yes	The instance ID of the IPv6 gateway that you want to delete.	ipv6gw-hp3y0l3ln89j8****
RegionId	string	Yes	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 request fails the dry run, an error message is returned. If the request passes the dry run, `DryRunOperation` is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, the IPv6 gateway is deleted.	cn-huhehaote
DryRun	boolean	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.	false
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 client 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.	123e4567-e89b-12d3-a456-426655440000

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E9A8AABE-A84B-4AF2-A68A-8E2EA190E7AE

Examples

Success response

JSON format

{
  "RequestId": "E9A8AABE-A84B-4AF2-A68A-8E2EA190E7AE"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DependencyViolation.GatewayRouteTableRelation	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	IncorrectStatus.Ipv6Gateway	The status of %s [%s] is incorrect.	The IPv6 gateway is in an unstable state. Try again later.
400	DependencyViolation.EgressRules	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	DependencyViolation.Ipv6InternetBandwidth	The specified resource of %s depends on %s, so the operation cannot be completed.	The specified resource is dependent on other resources and the current operation is not allowed.
400	OperationFailed.RouteEntryUnstable	The operation is failed because of route entry related to it is unstable, please try later.	Because the routing entry associated with the instance is unstable, please try again later
400	Forbidden.OperateShareResource	You cannot operate shared resources.	Shared resources do not support this operation.
400	DependencyViolation.SharedIpv6InternetBandwidth	The IPv6 gateway [%s] has IPv6 address [%s] that enabled internet from share user [%s], please delete it and try again later.	The IPv6 gateway [%s] has IPv6 address [%s] that enabled internet from share user [%s], please delete it and try again later.
400	IncorrectStatus.Vpc	Vpc incorrect status.	VPC is not in steady state.
400	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.