DeleteTransitRouterPeerAttachment - Cloud Enterprise Network

Deletes an inter-region connection from an Enterprise Edition transit router.

Operation description

DeleteTransitRouterPeerAttachment 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 ListTransitRouterPeerAttachments to query the status of an inter-region connection.

If an inter-region connection is in the Detaching state, the inter-region connection is being deleted. You can query the inter-region connection but cannot perform other operations.
If an inter-region connection cannot be found, the inter-region connection is deleted.

Prerequisites

Before you begin, make sure that the Enterprise Edition transit router that you use to create inter-region connections meets the following prerequisites:

No associated forwarding correlation is established between the inter-region 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 inter-region 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 routes from route tables of Enterprise Edition transit routers, see DeleteTransitRouterRouteEntry .
The route table does not contain a route whose next hop is the inter-region connection and that is generated from a prefix list. You can delete routes from a route table by disassociating the route table from the prefix list. For more information, see DeleteTransitRouterPrefixListAssociation .
No quality of service (QoS) policy is configured for the inter-region connection. For more information about how to delete QoS policies, see DeleteCenInterRegionTrafficQosPolicy .

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:DeleteTransitRouterPeerAttachment	delete	TransitRouterPeerAttachment acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that you want to use 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.	02fb3da4-130e-11e9-8e44-001****
TransitRouterAttachmentId	string	Yes	The ID of the inter-region connection.	tr-attach-gyjhtx9sjsxhm6****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid 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 to pass the check, 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 inter-region connection. Valid values: false (default): Check for relevant resources, including associated forwarding and route learning, before deleting the inter-region connection. If such a resource exists, the VPC connection is not deleted and an error message is returned. true: Delete the inter-region connection and all relevant resources.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

Examples

Sample success responses

JSONformat

{
  "RequestId": "A01FEDD7-7D69-4EB3-996D-CF79F6F885CA"
}

Error codes

HTTP status code	Error code	Error message	Description
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.RouteEntryExist	Operation failed because the TransitRouterAttachment exists in RouteTable.	-
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.TrafficQosExist	Operation failed because TrafficQos exists	The error message returned because a QoS policy exists. Delete the QoS policy and try again.
400	InvalidValue.PrefixlistCidr	Invalid cidr exist in the specified prefixlist.	The error message returned because the specified prefix list contains an invalid CIDR block.
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	OperationFailed.NotSupportForceDelete	Not support force delete attachment.	The error message returned because the specified resource cannot be forcefully deleted.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	The error message returned because the ID of the network instance does not exist.
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	OperationFailed.MulticastGroupExist	Operation is failed because attachment exists in multicast groups.	The error message returned because the specified attachment is in a multicast group. Remove the attachment from the multicast group and try again.
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	OperationUnsupported.TransitRouterAttachment	The specified TransitRouterAttachment has configured TransitRegion. Please remove the configuration first.	The error message returned because bandwidth multiplexing is enabled. Disable bandwidth multiplexing 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
2024-01-11	The Error code has changed	View Change Details
2023-07-31	The Error code has changed	View Change Details
2023-03-10	The Error code has changed. The request parameters of the API has changed	View Change Details
2022-12-22	The Error code has changed	View Change Details