DeleteTransitRouterVpnAttachment - Cloud Enterprise Network

Deletes a VPN attachment.

Operation description

Before you call the DeleteTransitRouterVpnAttachment operation, make sure that all request parameters are valid. If a request parameter is invalid, a request ID is returned, but the VPN attachment is not deleted.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.	123e4567-e89b-12d3-a456-42665544****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request.	false
TransitRouterAttachmentId	string	Yes	The ID of the VPN attachment.	tr-attach-b9xj1dv69600kj****
Force	boolean	No	Specifies whether to forcefully delete the VPN attachment. Valid values: false (default): Check for resource dependencies, such as associated forwarding and route learning, before the VPN attachment is deleted. If such resources exist, the VPN attachment is not deleted and an error message is returned. true: Delete the resource dependencies along with the VPN attachment.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	FA43C571-E88B-56C0-8FF8-5646D9B96297

Examples

Sample success responses

JSONformat

{
  "RequestId": "FA43C571-E88B-56C0-8FF8-5646D9B96297"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.RouteTableAssociationExist	Operation failed because TransitRouterRouteTable exists.	The error message returned because a transit router route table (TransitRouterRouteTable) exists.
400	OperationFailed.RouteEntryExist	Operation failed because the TransitRouterAttachment exists in RouteTable.	-
400	InvalidTransitRouterAttachmentId.NotFound	The TransitRouterAttachmentId is not found.	The error message returned because the specified transit router attachment ID (TransitRouterAttachmentId) does not exist.
400	OperationFailed.NotSupportForceDelete	Not support force delete attachment.	The error message returned because the specified resource cannot be forcefully deleted.
400	OperationUnsupported.TransitRouterType	The operation is not supported because of the wrong transitRouter type.	The error message returned because this operation is not supported by the specified type of transit router.
400	IncorrectStatus.ResourceStatus	The resource is not in a valid state for the attachment operation.	The error message returned because this operation is not supported when the specified resource is in an unstable state. Try again later.
400	OperationFailed.RouteTablePropagationExist	Operation failed because You are not allowed to delete TransitAttachment with TransitRouter RouteTable Associated.	The error message returned because the transit route attachment (TransitAttachment) is associated with a route table. Disassociate the attachment from the route table and try again.
400	OperationFailed.PrefixListExist	Operation failed because PrefixList exists.	The error message returned because a prefix list exists.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2022-12-22	The Error code has changed	View Change Details
2022-12-02	The Error code has changed. The request parameters of the API has changed	View Change Details