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

Usage notes

DeleteTransitRouterPeerAttachment is an asynchronous operation. After you send a request, the system returns the request ID but the operation is still being performed in the system 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 such routes 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteTransitRouterPeerAttachment

The operation that you want to perform. Set the value to DeleteTransitRouterPeerAttachment.

ClientToken String No 02fb3da4-130e-11e9-8e44-001****

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 different requests. ClientToken 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 of each API request may be different.
TransitRouterAttachmentId String Yes tr-attach-gyjhtx9sjsxhm6****

The ID of the inter-region connection.

DryRun Boolean No false

Specifies whether to only precheck the request. Check items include permissions and the status of the transit router. Valid values:

  • false (default): sends the request. If the request passes the precheck, the inter-region connection is deleted.
  • true: sends a request for precheck only. The inter-region connection is not deleted after the request passes the precheck. If you use this value, the system checks the required parameters and the request syntax. If the request fails to pass the precheck, an error message is returned. If the request passes the check, the system returns the ID of the request.

Response parameters

Parameter Type Example Description
RequestId String A01FEDD7-7D69-4EB3-996D-CF79F6F885CA

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteTransitRouterPeerAttachment
&ClientToken=02fb3da4-130e-11e9-8e44-001****
&TransitRouterAttachmentId=tr-attach-gyjhtx9sjsxhm6****
&DryRun=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteTransitRouterPeerAttachmentResponse>
    <RequestId>A01FEDD7-7D69-4EB3-996D-CF79F6F885CA</RequestId>
</DeleteTransitRouterPeerAttachmentResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 OperationFailed.RouteEntryExist Operation failed because the TransitRouterAttachment exists in RouteTable. The error message returned because you cannot perform the operation when the specified inter-region connection is specified as the next hop of one or more routes in the route table.
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.

For a list of error codes, visit the API Error Center.