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 No 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 region IDs.

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 on each page. Default value: 20. Maximum value: 100.

NextToken String No 1

The token for returning the next page when the data is returned in more than one page.

Response parameters

Parameter Type Example Description
MaxResults Integer 20

The number of entries returned per page.

NextToken String dd20****

The token for returning the next page when the data is returned in more than one page.

RequestId String AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

TransitRouterAttachments Array of TransitRouterAttachment

The list of cross-region connections.

AutoPublishRouteEnabled Boolean false

Specifies whether to enable the Enterprise Edition transit router to automatically advertise routes of the cross-region connection to the peer region. Valid values:

  • false: disables automatic route advertisement. This is the default value.
  • true: enables automatic route advertisement.
Bandwidth Integer 2

The bandwidth allocated to the cross-region connection. Unit: Mbit/s.

BandwidthPackageId String cenbwp-3xrxupouolw5ou****

The ID of the bandwidth plan.

CenBandwidthPackageId String cenbwp-3xrxupouolw5ou****

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

CreationTime String 2021-06-16T02:50Z

The time when the cross-region connection was created.

The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.

GeographicSpanId String china_china

The areas to be connected.

PeerTransitRouterId String tr-m5eq27g6bndum7e88****

The ID of the peer transit router.

PeerTransitRouterOwnerId Long 1688111111111111

The UID of the account to which the peer transit router belongs.

PeerTransitRouterRegionId String cn-qingdao

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

RegionId String cn-hangzhou

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

ResourceType String TR

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

  • VPC: a virtual private cloud (VPC)
  • CCN: a Cloud Connect Network (CCN) instance
  • VBR: a virtual border router (VBR)
  • TR: a transit router
Status String Attached

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

  • Attached: The transit router is connected to the network instance.
  • Attaching: The transit router is connecting to the network instance.
  • Detaching: The transit router is disconnecting from the network instance.
  • Detached: The transit router is disconnected from the network instance.
TransitRouterAttachmentDescription String testdesc

The description of the cross-region connection.

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

The ID of the cross-region connection.

TransitRouterAttachmentName String test

The name of the cross-region connection.

TransitRouterId String tr-bp1su1ytdxtataupl****

The ID of the Enterprise Edition transit router.

Examples

Sample requests

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

Sample success responses

XML format

<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>1688111111111111</PeerTransitRouterOwnerId>
        <TransitRouterAttachmentName>test</TransitRouterAttachmentName>
        <ResourceType>TR</ResourceType>
        <AutoPublishRouteEnabled>false</AutoPublishRouteEnabled>
        <Bandwidth>0</Bandwidth>
        <CreationTime>2021-06-16T02:50Z</CreationTime>
        <BandwidthPackageId></BandwidthPackageId>
        <PeerTransitRouterId>tr-m5eq27g6bndum7e88****</PeerTransitRouterId>
        <RegionId>cn-hangzhou</RegionId>
        <CenBandwidthPackageId></CenBandwidthPackageId>
        <PeerTransitRouterRegionId>cn-qingdao</PeerTransitRouterRegionId>
        <TransitRouterId>tr-bp1su1ytdxtataupl****</TransitRouterId>
  </TransitRouterAttachments>
</ListTransitRouterPeerAttachmentsResponse>

JSON format

{
  "TotalCount": 1,
  "RequestId": "AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0",
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "TransitRouterAttachmentId": "tr-attach-5u4qbayfv2io5v****",
      "Status": "Attached",
      "GeographicSpanId": "china_china",
      "PeerTransitRouterOwnerId": "1688111111111111",
      "TransitRouterAttachmentName": "test",
      "ResourceType": "TR",
      "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.

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