Deletes a customer gateway.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String  Yes DeleteCustomerGateway

The name of this aciton. Value: DeleteCustomerGateway

CustomerGatewayId String  Yes vpn-bp1q8bgx4xnkm2ogj****

The ID of the customer gateway.

RegionId String Yes cn-shanghai

The ID of the region to which the customer gateway belongs. To query the region ID, call DescribeRegions.

ClientToken String No 02fb3da4-130e-11e9-8e44-0016e04115b

The client token that guarantees the idempotence of the request.

The value of this parameter is generated by the client. Make sure that this value is unique among different requests and does not exceed 64 ASCII characters.

Response parameters

Parameter Type Example value Description
RequestId String 606998F0-B94D-48FE-8316-ACA81BB230DA

The ID of the request.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DeleteCustomerGateway
&CustomerGatewayId=vpn-bp1q8bgx4xnkm2ogj****
&RegionId=cn-shanghai
&<CommonParameters>

Response example

XML format

<DeleteCustomerGatewayResesponse>
      <RequestId>606998F0-B94D-48FE-8316-ACA81BB230DA</RequestId>
</DeleteCustomerGatewayResesponse>

JSON format

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

Errors

HTTP status code Error code Error message Description
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. You are not authorized to operate on this resource.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource.
404 InvalidCustomerGatewayInstanceId.NotFound The specified customer gateway instance id does not exist. The specified instance does not exist.

For a list of error codes, visit the API Error Center.