Use DeleteTransitRouterVbrAttachment to delete a VBR connection - Cloud Enterprise Network - Alibaba Cloud - 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 RequestId but the VBR connection is not immediately deleted. The deletion task runs in the background. You can call ListTransitRouterVbrAttachments to query the status of the VBR connection.

If the VBR connection is in the Detaching state, the VBR connection is being deleted. In this state, you can only query the VBR connection but cannot perform other operations on it.
If the VBR connection cannot be found, the VBR connection is deleted.

When you call the DeleteTransitRouterVbrAttachment operation, make sure that the parameter values you specify are valid. If you specify invalid parameter values, the system still returns a RequestId but does not delete the VBR connection from the Enterprise Edition transit router.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DeleteTransitRouterVbrAttachment

delete

*TransitRouterVbrAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

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 different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	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, including permission and instance status verification. Valid values: false (default): Sends a normal request and directly deletes the VBR connection after the request passes the check. true: Sends a check request without deleting the VBR connection. The check items include whether required parameters are specified and the request format. If the check fails, the corresponding error is returned. If the check succeeds, the corresponding request ID is returned.	false
Force	boolean	No	Specifies whether to force delete the VBR connection. Valid values: false (default): Before deleting the VBR connection, the system checks whether related resource dependencies exist, such as associated forwarding and routing learning. If dependencies exist, the deletion is not allowed and the corresponding error is returned. true: When deleting the VBR connection, the system deletes all related dependencies by default.	false

Response elements

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

Examples

Success response

JSON format

{
  "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	OperationFailed.VbrWithAllowPrefixes	Operation failed because allow prefixes referenced by vbr exists.	A route prefix on the VBR is assigned the Allow action, which causes the operation to fail.
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	InstanceReferenced.VbrRouteEntry	Operation is failed because there is at least one route entry which next hop is the specified attachment.	Operation is failed because there is at least one route entry which next hop is the specified attachment.
400	OperationNotPermitted.AttachmentManagedByCloudService	The specified Attachment managed by cloud service can only be deleted through cloud service.
400	InvalidParameter.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.