Call the DeleteCustomerGateway API to delete a customer gateway - VPN Gateway - Alibaba Cloud - VPN Gateway

Operation description

Before deleting a customer gateway, make sure that the customer gateway is not associated with any IPsec connections. To delete IPsec connections, see DeleteVpnAttachment or DeleteVpnConnection.

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

delete

*CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the customer gateway. You can obtain the region ID by calling the DescribeRegions operation.	cn-shanghai
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates this parameter value, which must be unique among different requests. The maximum length is 64 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****
CustomerGatewayId	string	Yes	The ID of the customer gateway instance.	cgw-bp1pvpl9r9adju6l5****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	606998F0-B94D-48FE-8316-ACA81BB230DA

Examples

Success response

JSON format

{
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA"
}

Error codes

HTTP status code	Error code	Error message	Description
400	DependencyViolation.VpnConnection	There are vpn connections on specified customer gateway not deleted.	The error message returned because VPN connections to the specified customer gateway are not deleted.
400	VpnGateway.task.conflict	The VPN is in the configuration state, please wait a while before operating.	The VPN is in the configuration state, please wait a while before operating.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.	The specified customer gateway does not exist. Check whether the ID of the customer gateway is correct.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.