DeleteTransitRouterVbrAttachment - Cloud Enterprise Network

Deletes a virtual border router (VBR) connection from an Enterprise Edition transit router.

Operation description

DeleteTransitRouterVbrAttachment 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 ListTransitRouterVbrAttachments operation to query the status of a VBR connection.

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

Prerequisites

Before you delete a VBR connection for an Enterprise Edition transit router, make sure that the following requirements are met:

No associated forwarding correlation is established between the VBR 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 VBR 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 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 route entries, see DeleteTransitRouterRouteEntry .
The route tables of the Enterprise Edition transit router do not contain a route whose next hop is the VBR connection and that is generated from a prefix list. 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:DeleteTransitRouterVbrAttachment		TransitRouterVbrAttachment 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 value, but you must make sure that it is unique among all requests. The client 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 VBR connection.	tr-attach-9nlnjv7by7n7a****
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 the 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 forcibly delete the VBR connection. Valid values: false (default): checks for resources related to the VBR connection, such as associated forwarding and route learning policies. If such resources exist, the VBR connection is not deleted and an error message is returned. true: deletes the VBR connection and related resources.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	3EDA94DE-0AE5-41FC-A91E-7170E408E0FD

Examples

Sample success responses

JSONformat

{
  "RequestId": "3EDA94DE-0AE5-41FC-A91E-7170E408E0FD"
}

Error codes

HTTP status code	Error code	Error message	Description
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.VbrAttachedVbrHa	The operation is failed because of VbrAttachedVbrHa.	-
400	OperationFailed.FlowLogExistOrNisOpened	Operation failed because FlowLog exists or Nis opened.	The error message returned because this operation is not supported when a flow log exists or the NIS service is activated.
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	InstanceReferenced.VpcRouteEntry	The specified attachment is referenced by vpc route entry.	The error message returned because the next hop of a VPC route is the specified attachment.
400	OperationFailed.NotSupportForceDelete	Not support force delete attachment.	The error message returned because the specified resource cannot be forcefully deleted.
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.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.
400	Unauthorized	The AccessKeyId is unauthorized.	-

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

Change history

Change time	Summary of changes	Operation
2024-02-02	The Error code has changed	View Change Details
2023-09-08	The Error code has changed	View Change Details
2023-01-10	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