Queries virtual border router (VBR) connections on an Enterprise Edition transit router.

Description

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

  • Specify the ID of the Enterprise Edition transit router.
  • Specify the ID of the relevant Cloud Enterprise Network (CEN) instance and the region ID of the Enterprise Edition transit router.

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 ListTransitRouterVbrAttachments

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

CenId String No cen-j3jzhw1zpau2km****

The ID of the CEN instance.

RegionId String No cn-hangzhou

The region ID of the Enterprise Edition transit router.

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

TransitRouterAttachmentId String No tr-attach-oyf70wfuorwx87****

The ID of the VBR 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. Default value: 20.

NextToken String No dd20****

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 F42D9616-29EB-4E75-8CA8-9654D4E07501

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

TransitRouterAttachments Array of TransitRouterAttachment

The list of VBR connections.

AutoPublishRouteEnabled Boolean false

Indicates whether the Enterprise Edition transit router automatically advertises routes to the VBR. Valid values:

  • false (default): no
  • true: yes
CreationTime String 2021-06-15T15:20Z

The time when the VBR connection was established.

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

ResourceType String VBR

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 status of the VBR connection. Valid values:

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

The description of the VBR connection.

TransitRouterAttachmentId String tr-attach-oyf70wfuorwx87****

The ID of the VBR connection.

TransitRouterAttachmentName String testa

The name of the VBR connection.

TransitRouterId String tr-bp1su1ytdxtataupl****

The ID of the Enterprise Edition transit router.

VbrId String vbr-bp1svadp4lq38janc****

The ID of the VBR.

VbrOwnerId Long 1688111111111111

The ID of the account to which the VBR belongs.

VbrRegionId String cn-hangzhou

The region ID of the VBR.

Examples

Sample requests

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

Sample success responses

XML format

<ListTransitRouterVbrAttachmentsResponse> 
  <TotalCount>1</TotalCount>
  <RequestId>F42D9616-29EB-4E75-8CA8-9654D4E07501</RequestId>
  <MaxResults>20</MaxResults>
  <TransitRouterAttachments>
        <TransitRouterAttachmentId>tr-attach-oyf70wfuorwx87****</TransitRouterAttachmentId>
        <Status>Attached</Status>
        <AutoPublishRouteEnabled>false</AutoPublishRouteEnabled>
        <VbrOwnerId>1688111111111111</VbrOwnerId>
        <CreationTime>2021-06-15T15:20Z</CreationTime>
        <TransitRouterAttachmentName>testa</TransitRouterAttachmentName>
        <VbrRegionId>cn-hangzhou</VbrRegionId>
        <ResourceType>VBR</ResourceType>
        <VbrId>vbr-bp1svadp4lq38janc****</VbrId>
  </TransitRouterAttachments>
</ListTransitRouterVbrAttachmentsResponse>

JSON format

{
  "TotalCount": 1,
  "RequestId": "F42D9616-29EB-4E75-8CA8-9654D4E07501",
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "TransitRouterAttachmentId": "tr-attach-oyf70wfuorwx87****",
      "Status": "Attached",
      "AutoPublishRouteEnabled": false,
      "VbrOwnerId": "1688111111111111",
      "CreationTime": "2021-06-15T15:20Z",
      "TransitRouterAttachmentName": "testa",
      "VbrRegionId": "cn-hangzhou",
      "ResourceType": "VBR",
      "VbrId": "vbr-bp1svadp4lq38janc****"
    }
  ]
}

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.