Help & DocumentationAPIsVirtual Private CloudVPC API 2017APIs for VPN GatewayAPIs for Peer GatewayDelete Peer Gateway

Delete Peer Gateway

Last updated: 2019-11-29 19:17:09

Contents：

1. API Description

This API (DeleteUserGw) is used to delete customer gateway.
Domain for API request: vpc.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is DeleteUserGw.

Parameter Name Required Type Description
userGwId Yes String Customer gateway ID, for example: cgw-ekrvxcdv. You can query customer gateways by using the DescribeUserGw API.

3. Output Parameters

Parameter Name Type Description
code Int Common error code; 0: Succeeded; other values: Failed. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.

4. Error Codes

The following list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.

Error code Description
InvalidUserGw.NotFound Invalid customer gateway. Customer gateway resource does not exist. Please verify that the resource information you entered is correct.

5. Example

Input

https://vpc.api.qcloud.com/v2/index.php?Action=DeleteUserGw
&<Common request parameters>
&userGwId=cgw-ekrvxcdv

Output

{
    "code":"0",
    "message":""
}