DeleteDirectConnectGateway

Last updated: 2024-11-25 20:09:37

1. API Description

Domain name for API request: vpc.intl.tencentcloudapi.com.

This API is used to delete a direct connect gateway.

For a NAT gateway, NAT and ACL rules will be cleared upon the deletion of a direct connect gateway.

After the deletion of a direct connect gateway, the routing policy associated with the gateway in the route table will also be deleted. This API is completed asynchronously. If you need to query the async job execution results, please use the `RequestId` returned by this API to poll the `QueryTask` API.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DeleteDirectConnectGateway.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
DirectConnectGatewayId	Yes	String	The unique `ID` of the direct connect gateway, such as `dcg-9o233uri`.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Deleting a direct connect gateway

Input Example

https://vpc.intl.tencentcloudapi.com/?Action=DeleteDirectConnectGateway
&DirectConnectGatewayId=dcg-9o233uri
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "fcb47621-838b-428e-8c33-6e210d93c451"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InvalidParameterValue	The parameter value is invalid.
InvalidParameterValue.Malformed	Invalid input parameter format.
ResourceInUse	The resource is occupied.
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.
UnsupportedOperation.AppIdMismatch	The resource is not under the specified AppId.
UnsupportedOperation.DCGatewayNatRuleExists	Unable to delete: There’re NAT rules associated with this direct connect gateway. Please delete all NAT rules first.
UnsupportedOperation.RouteTableHasSubnetRule	The routing table is bound to a subnet.

tencent cloud

Recent Pages