Queries one or more Virtual Border Routers (VBRs).

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
Action String Required DescribeVirtualBorderRouters

The name of this action. Value: DescribeVirtualBorderRouters.

RegionId String Yes cn-shanghai

The ID of the region where the VBR is located. To query the region ID, call DescribeRegions.

Filter.N.Key String No 1

The type of the nth filter. Value range of n: 1 to 5.

Filter.N.Value.N RepeatList No 1

The mth value of the nth filter. Value range of m: 1 to 5.

PageNumber Integer No 10

The number of pages to return. Default value: 1.

PageSize Integer No 1

The number of rows per page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example value Description
VirtualBorderRouterSet

A list of VBRs.

  └AccessPointId String ap-cn-kojok1xxxxxxxx

The ID of the physical connection access point.

  └ActivationTime String 2017-06-08T12:20:55

The first time at which the VBR was activated.

  └AssociatedCens

The associated CEN instances.

    └CenId String cen-kojok19xxxxxxxx

The ID of the CEN instance.

    └CenOwnerId Long 1086496381294461

The UID of the account to which the CEN instance belongs.

    └CenStatus String Attached

The status of the CEN instance.

  └AssociatedPhysicalConnections

The associated physical connections.

    └CircuitCode String 12

The circuit code provided by the service provider for the physical connection-side interface of the VBR.

    └ LocalGatewayIp String 116.62.xx.xx

The local IP address of the physical connection-side interface of the VBR.

    └PeerGatewayIp String 116.62.xx.xx

The peer IP address of the physical connection-side interface of the VBR.

    └ PeeringSubnetMask String 255.255.255.252

The subnet mask for the local and peer IP addresses of the physical connection-side interface of the VBR.

    └PhysicalConnectionBusinessStatus String Normal

The status of the physical connection.

    └PhysicalConnectionId String pc-119mfjzm7xxxxxxxx

The ID of the physical connection to which the VBR belongs.

    └PhysicalConnectionOwnerUid String qfrgrgs

The UID of the owner of the physical connection.

    └PhysicalConnectionStatus String Normal

The status of the physical connection.

    └VlanId String 0

The VLAN ID of the VBR.

    └VlanInterfaceId String ri-kojok19x3j0q6kxxxxxxxxx

The ID of the physical connection-side interface of the VBR. This route interface can operate as the next hop of routes on the VBR.

  └CircuitCode String longtel001

The circuit code provided by the service provider for the physical connection.

  └ CreationTime String 2017-06-08T12:20:55

The time at which the VBR was created.

  └Description String VBR

The description of the VBR.

  └DetectMultiplier Long 3

The multiple of the detection time. The Max Connection packet loss allowed by the receiver. It is used to detect if the link is normal. Value range: 3 to 10.

  └LocalGatewayIp String 116.62.xx.xx

The Alibaba Cloud-side IP address.

  └MinRxInterval Long 100

The BFD packet receiving interval. Value range: 200 to 1,000. Unit: ms.

  └MinTxInterval Long 100

The BFD packet sending interval. Value range: 200 to 1,000. Unit: ms.

  └Name String test

The name of the VBR.

  └PeerGatewayIp String 116.62.xx.xx

The client-side IP address.

  └PeeringSubnetMask String 255.255.255.252

The subnet mask for the Alibaba Cloud-side IP address and the client-side IP address.

  └PhysicalConnectionBusinessStatus String Normal

The business status of the physical connection.

  └PhysicalConnectionId String pc-119mfjzm7xxxxxxxx

The ID of the physical connection to which the VBR belongs.

  └PhysicalConnectionOwnerUid String usdgbh123fvgf

The UID of the owner of the physical connection.

  └PhysicalConnectionStatus String Normal

The status of the physical connection.

  └RecoveryTime String 2017-06-08T12:20:55

The last time at which the VBR recovered from the Terminated status to the Active status.

  └ RouteTableId String rtb-bp1nxxxxxxxxxxxxxxxx

The ID of the route table of the VBR.

  └Status String active

The status of the physical connection:

  • Initial: applying
  • Approved: approved
  • Allocating: allocating resources
  • Allocated: access construction
  • Confirmed: waiting for user confirmation
  • Enabled: enabled
  • Rejected: rejected
  • Canceled: canceled
  • Allocation Failed: resource allocation failed
  • Terminated: terminated
  └TerminationTime String 2017-06-08T12:20:55

The last time at which the VBR was terminated.

  └VbrId String vbr-kojok19xxxxxxxxx

The ID of the VBR.

  └VlanId Integer 10

The VLAN ID of the VBR.

  └VlanInterfaceId String ri-2zeo3xzyf38r4xxxxxxxx

The ID of the router interface of the VBR.

TotalCount Integer 10

The number of queried entries.

PageNumber Integer 10

The current page number.

PageSize Integer   10

The number of entries per page.

RequestId String DE77A7F3-3B74-41C0-A5BC-CAFD188C28B6

The ID of the request.

Examples

Request example


http(s)://vpc.aliyuncs.com/? Action=DescribeVirtualBorderRouters
&RegionId=cn-shanghai
&<CommonParameters>

Response example

XML format

<DescribeVirtualBorderRoutersResponse>
  <RequestId>AE65530E-8436-4FB1-8217-DCD35712AC89</RequestId>
  <PageNumber>1</PageNumber>
  <VirtualBorderRouterSet>
    <VirtualBorderRouterType>
      <LocalGatewayIp>10.1.xx.xx</LocalGatewayIp>
      <PeerGatewayIp>10.2.xx.xx</PeerGatewayIp>
      <PhysicalConnectionOwnerUid>123157908XXXXXXXX</PhysicalConnectionOwnerUid>
      <VlanId>10</VlanId>
      <PhysicalConnectionStatus>Enabled</PhysicalConnectionStatus>
      <PhysicalConnectionId>pc-2zeoaxkq3jotxxxxxxxx</PhysicalConnectionId>
      <RouteTableId>vtb-2ze9hmd6yofwvxxxxxxxx</RouteTableId>
      <PeeringSubnetMask>255.0.0.0</PeeringSubnetMask>
      <CreationTime>2018-03-06T11:16:34Z</CreationTime>
      <ActivationTime>2018-03-06T11:16:34Z</ActivationTime>
      <Status>active</Status>
      <PhysicalConnectionBusinessStatus>Normal</PhysicalConnectionBusinessStatus>
      <VlanInterfaceId>ri-2zeum6rgu0586xxxxxxxx</VlanInterfaceId>
      <AccessPointId>ap-cn-beijing-dx-A</AccessPointId>
      <VbrId>vbr-2zecmmvg5gxxxxxxxx</VbrId>
    </VirtualBorderRouterType>
  </VirtualBorderRouterSet>
  <TotalCount>1</TotalCount>
  <PageSize>10</PageSize>
</DescribeVirtualBorderRoutersResponse>

JSON format

{
	"DescribeVirtualBorderRoutersResponse":{
		"PageNumber": "1",
		"VirtualBorderRouterSet":{
			"VirtualBorderRouterType":{
				"LocalGatewayIp":"10.1.xx.xx",
				"PeerGatewayIp":"10.2.xx.xx",
				"PhysicalConnectionOwnerUid":"123157908XXXXXXXX",
				"VlanId":"10",
				"PhysicalConnectionStatus":"Enabled",
				"PhysicalConnectionId":"pc-2zeoaxkq3jotxxxxxxxx",
				"RouteTableId":"vtb-2ze9hmd6yofwvxxxxxxxx",
				"PeeringSubnetMask":"255.0.0.0",
				"CreationTime":"2018-03-06T11:16:34Z",
				"ActivationTime":"2018-03-06T11:16:34Z",
				"Status":"active",
				"PhysicalConnectionBusinessStatus":"Normal",
				"VlanInterfaceId":"ri-2zeum6rgu0586xxxxxxxx",
				"VbrId":"vbr-2zecmmvg5gxxxxxxxx",
				"AccessPointId":"ap-cn-beijing-dx-A"
			}
		},
		"TotalCount": "1",
		"PageSize": 10,
		"RequestId":"AE65530E-8436-4FB1-8217-DCD35712AC89"
	}
}

Error codes

HTTP status code Error code Error message  Description
404 InvalidFilterKey.ValueNotSupported Specified filter key is not supported: Filter.X.key The key of the filter does not support: Filter.X.key

See common error codes