Queries the cross-region connections on an Enterprise Edition transit router.

Description

You can use the following methods to query the cross-region connections on an Enterprise Edition transit router:

  • Query all cross-region connections on an Enterprise Edition transit router by specifying the ID of the Enterprise Edition transit router.
  • Query all cross-region connections on an Enterprise Edition transit router by specifying the ID of the Cloud Enterprise Network (CEN) instance and the ID of the region where the transit router is deployed.

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 ListTransitRouterPeerAttachments

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

CenId String No cen-j3jzhw1zpau2km****

The ID of the CEN instance.

RegionId String No cn-hangzhou

The ID of the region where the Enterprise Edition transit router is deployed.

You can call the DescribeRegions operation to query the most recent region list.

TransitRouterAttachmentId String No tr-attach-5u4qbayfv2io5v****

The ID of the cross-region connection.

TransitRouterId String No tr-bp1su1ytdxtataupl****

The ID of the Enterprise Edition transit router.

MaxResults Integer No 20

The number of entries to return per page. The default value is 20. The maximum value is 100.

NextToken String No 1

The token that is used for the next query. Valid values:

  • If this is your first query or no next query is to be sent, ignore this parameter.
  • If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.

Response parameters

Parameter Type Example Description
NextToken String dd20****

The token that is used for the next query. Valid values:

  • If the returned value of NextToken is empty, it indicates that no next query is to be sent.
  • If the returned value of NextToken is not empty, the value indicates the token that is used for the next query.
RequestId String AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0

The ID of the request.

TotalCount Integer 1

The number of entries returned.

MaxResults Integer 20

The number of entries returned per page.

TransitRouterAttachments Array of TransitRouterAttachment

The list of cross-region connections.

CreationTime String 2021-06-16T02:50Z

The time when the cross-region connection was created.

The time follows the ISO8601 standard in the YYYY-MM-ddTHH:mmZ format. The time is displayed in UTC.

Status String Attached

The status of the cross-region connection. Valid values:

  • Attached: The local transit router is connected to the peer transit router.
  • Attaching: The local transit router is connecting to the peer transit router.
  • Detaching: The local transit router is disconnecting from the peer transit router.
  • Detached: The local transit router is disconnected from the peer transit router.
TransitRouterAttachmentId String tr-attach-5u4qbayfv2io5v****

The ID of the cross-region connection.

BandwidthType String BandwidthPackage

The bandwidth allocation method. Valid values:

BandwidthPackage: allocates bandwidth from a bandwidth plan.

DataTransfer: uses pay-by-data-transfer bandwidth.

CenBandwidthPackageId String cenbwp-3xrxupouolw5ou****

The ID of the bandwidth plan that is used to allocate bandwidth to the cross-region connection.

TransitRouterAttachmentDescription String testdesc

The description of the cross-region connection.

RegionId String cn-hangzhou

The ID of the region where the Enterprise Edition transit router is deployed.

PeerTransitRouterId String tr-m5eq27g6bndum7e88****

The ID of the peer transit router.

TransitRouterId String tr-bp1su1ytdxtataupl****

The ID of the Enterprise Edition transit router.

PeerTransitRouterRegionId String cn-qingdao

The ID of the region where the peer transit router is deployed.

ResourceType String TR

The type of the resource to which the transit router is connected. Valid values:

  • VPC: virtual private cloud (VPC)
  • CCN: Cloud Connect Network (CCN) instance
  • VBR: virtual border router (VBR)
  • TR: transit router
Bandwidth Integer 2

The bandwidth value of the cross-region connection. Unit: Mbit/s.

  • If BandwidthType is set to BandwidthPackage, this parameter indicates the bandwidth that is available for the cross-region connection.

  • If BandwidthType is set to DataTransfer, this parameter indicates the bandwidth limit of the cross-region connection.
GeographicSpanId String china_china

The areas that are connected by the bandwidth plan.

PeerTransitRouterOwnerId Long 253460731706911258

The ID of the Alibaba Cloud account to which the peer transit router belongs.

AutoPublishRouteEnabled Boolean false

Indicates whether the local Enterprise Edition transit router automatically advertises routes of the cross-region connection to the peer transit router. Valid values:

  • false (default): no
  • true: yes
TransitRouterAttachmentName String test

The name of the cross-region connection.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTransitRouterPeerAttachments
&<Common request parameters>

Sample success responses

XML format

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

<ListTransitRouterPeerAttachmentsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0</RequestId>
    <MaxResults>20</MaxResults>
    <TransitRouterAttachments>
        <TransitRouterAttachmentId>tr-attach-5u4qbayfv2io5v****</TransitRouterAttachmentId>
        <Status>Attached</Status>
        <GeographicSpanId>china_china</GeographicSpanId>
        <PeerTransitRouterOwnerId>253460731706911258</PeerTransitRouterOwnerId>
        <TransitRouterAttachmentName>test</TransitRouterAttachmentName>
        <ResourceType>TR</ResourceType>
        <BandwidthType>BandwidthPackage</BandwidthType>
        <AutoPublishRouteEnabled>false</AutoPublishRouteEnabled>
        <Bandwidth>0</Bandwidth>
        <CreationTime>2021-06-16T02:50Z</CreationTime>
        <BandwidthPackageId/>
        <PeerTransitRouterId>tr-m5eq27g6bndum7e88****</PeerTransitRouterId>
        <RegionId>cn-hangzhou</RegionId>
        <CenBandwidthPackageId/>
        <PeerTransitRouterRegionId>cn-qingdao</PeerTransitRouterRegionId>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
    </TransitRouterAttachments>
</ListTransitRouterPeerAttachmentsResponse>

JSON format

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

{
  "TotalCount" : 1,
  "RequestId" : "AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0",
  "MaxResults" : 20,
  "TransitRouterAttachments" : [ {
    "TransitRouterAttachmentId" : "tr-attach-5u4qbayfv2io5v****",
    "Status" : "Attached",
    "GeographicSpanId" : "china_china",
    "PeerTransitRouterOwnerId" : "253460731706911258",
    "TransitRouterAttachmentName" : "test",
    "ResourceType" : "TR",
    "BandwidthType" : "BandwidthPackage",
    "AutoPublishRouteEnabled" : false,
    "Bandwidth" : 0,
    "CreationTime" : "2021-06-16T02:50Z",
    "BandwidthPackageId" : "",
    "PeerTransitRouterId" : "tr-m5eq27g6bndum7e88****",
    "RegionId" : "cn-hangzhou",
    "CenBandwidthPackageId" : "",
    "PeerTransitRouterRegionId" : "cn-qingdao",
    "TransitRouterId" : "tr-bp1su1ytdxtataupl****"
  } ]
}

Error codes

HttpCode Error code Error message Description
400 IllegalParam.NextToken The specified NextToken is invalid. The error message returned because the value of NextToken is invalid.
400 IllegalParam.TrInstance The specified TransitRouter is invalid. The error message returned because the ID of the transit router is invalid.
400 IllegalParam.CenId The specified CenId is invalid. The error message returned because the ID of the CEN instance is invalid.

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