DeleteTransitRouterVpcAttachment - Cloud Enterprise Network

Deletes a virtual private cloud (VPC) connection from an Enterprise Edition transit router.

Operation description

DeleteTransitRouterVpcAttachment is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterVpcAttachments operation to query the status of a VPC connection.

If a VPC connection is in the Detaching state, the VPC connection is being deleted. You can query the VPC connection but cannot perform other operations.
If a VPC connection cannot be found, it is deleted.

Prerequisites

Before you delete a VPC connection, make sure that the following requirements are met:

No associated forwarding correlation is established between the VPC connection and the route tables of the Enterprise Edition transit router. For more information about how to delete an associated forwarding correlation, see DissociateTransitRouterAttachmentFromRouteTable .
No route learning correlation is established between the VPC connection and the route tables of the Enterprise Edition transit router. For more information about how to delete a route learning correlation, see DisableTransitRouterRouteTablePropagation .
The route table of the VPC does not contain routes that point to the VPC connection. For more information about how to delete routes from a VPC route table, see DeleteRouteEntry .
The route tables of the Enterprise Edition transit router do not contain a custom route entry whose next hop is the network instance connection. For more information about how to delete custom routes from the route tables of an Enterprise Edition transit router, see DeleteTransitRouterRouteEntry .
The route tables of the Enterprise Edition transit router do not contain a route that is generated from a prefix list and the next hop is the VPC connection. You can delete such routes by disassociating the route table from the prefix list. For more information, see DeleteTransitRouterPrefixListAssociation .

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cen:DeleteTransitRouterVpcAttachment	delete	TransitRouterVpcAttachment acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}	none	none

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 all requests. The token can contain only ASCII characters. Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.	02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentId	string	Yes	The ID of the VPC connection.	tr-attach-ia340z7xis7t5s****
DryRun	boolean	No	Specifies whether to perform a dry run. Default values: false (default): performs a dry run and sends the request. true: performs a dry run. The system checks the required parameters and request syntax. If the request fails the dry run, an error message is returned. If the request passes the dry run, the system returns the ID of the request.	false
Force	boolean	No	Specifies whether to forcefully delete the VPC connection. Valid values: false (default): checks resources such as associated forwarding correlations and route learning policies that are related to the VPC connection before it is deleted. If such a resource exists, the VPC connection is not deleted and an error message is returned. true: deletes the VPC connection and all resources that are related to the VPC connection.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	7E61D334-4025-41EF-9145-FC327B35301D

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E61D334-4025-41EF-9145-FC327B35301D"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.AttachmentReferencedVpcRouteEntryExisted	Operation is failed because there is at least one route entry which next hop is the specified attachment.	The error message returned because this operation is not supported when a route points to an attachment.
400	OperationFailed.RouteTableAssociationExist	Operation failed because TransitRouterRouteTable exists	The error message returned because you cannot perform the operation when the connection is associated with a route table.
400	OperationFailed.RouteEntryExist	Operation failed because the TransitRouterAttachment exists in RouteTable.	-
400	OperationFailed.RouteTablePropagationExist	The specified TransitRouterAttachment has configured RouteTablePropagation. Please remove the configuration first.	The error message returned because you cannot perform the operation when a route learning correlation is configured for the network instance connection. Disassociate from the route learning correlation and try again.
400	OperationFailed.MulticastDomainAssociationExist	The specified TransitRouterAttachment has configured MulticastDomainAssociation. Please remove the configuration first.	The error message returned because the specified transit router attachment (TransitRouterAttachment) is added to a multicast domain. Remove the attachment from the multicast domain and try again.
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.	The error message returned because this operation is not supported by the specified type of transit router.
400	OperationFailed.PrefixListExist	Operation failed because PrefixList exists.	The error message returned because a prefix list exists.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	The error message returned because the ID of the network instance does not exist.
400	IncorrectStatus.VpcRouteEntry	The resource is not in a valid state for the attachment operation.	The error message returned because the status of the VPC route entry does not support this operation. Try again later.
400	IncorrectStatus.VpcSwitch	The resource is not in a valid state for the attachment operation.	The error message returned because the status of the vSwitch does not support this operation. Try again later.
400	IncorrectStatus.Vpc	The resource is not in a valid state for the operation.	The error message returned because the status of the VPC does not support this operation. Try again later.
400	OperationFailed.NotSupportForceDelete	Not support force delete attachment.	The error message returned because the specified resource cannot be forcefully deleted.
400	IncorrectStatus.VpcRouteTable	The resource is not in a valid state for the operation.	-
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
2024-07-10	The Error code has changed	View Change Details
2024-01-26	The Error code has changed	View Change Details
2023-03-27	The Error code has changed	View Change Details
2023-03-09	The Error code has changed	View Change Details
2023-01-04	The Error code has changed	View Change Details
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