Deletes a specified customer gateway.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DeleteCustomerGateway |
The operation that you want to perform. Set the value to DeleteCustomerGateway. |
RegionId | String | Yes | cn-shanghai |
The region ID of the customer gateway. You can call the DescribeRegions operation to query the most recent region list. |
ClientToken | String | No | 02fb3da4-130e-11e9-8e44-0016e04**** |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
|
CustomerGatewayId | String | Yes | cgw-bp1pvpl9r9adju6l5**** |
The ID of the customer gateway. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 606998F0-B94D-48FE-8316-ACA81BB230DA |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DeleteCustomerGateway
&RegionId=cn-shanghai
&CustomerGatewayId=cgw-bp1pvpl9r9adju6l5****
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DeleteCustomerGatewayResponse>
<RequestId>606998F0-B94D-48FE-8316-ACA81BB230DA</RequestId>
</DeleteCustomerGatewayResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "606998F0-B94D-48FE-8316-ACA81BB230DA"
}
Error codes
HttpCode | 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. | The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again. |
403 | Forbidden | User not authorized to operate on the specified resource. | The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again. |
404 | InvalidCustomerGatewayInstanceId.NotFound | The specified customer gateway instance id does not exist. | The error message returned because the specified customer gateway does not exist. Check whether the ID of the customer gateway is valid. |
For a list of error codes, visit the API Error Center.