edit-icon download-icon


Last Updated: Apr 09, 2018


Query the created Virtual Border Routers (VBRs).

The relationship between the values of a filter is “or”. A VBR is returned as long as one filter is met.

The relationship between each filter is “and”. A VBR is returned only when all the filters are met.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeVirtualBorderRouters

RegionId String Yes

The region of the VBR.

You can obtain the region ID by calling the DescribeRegions API.

Filter.n.Key String No

Filter keys. Valid value for n is [1,5]. Up to five filters are supported. The following are available filter keys:

  • VbrId: The ID of the VBR.

  • PhysicalConnectionId: The ID of the physical connection that the VBR is associated with.

  • AccessPointId: The ID of access point that the VBR connects to.

  • Status: The status of the VBR.

  • Name: The name of the VBR.

Filter.n.Value.m String No The corresponding value of the specified filter key. The valid value of m is [1, 5].
PageNumber Integer No The number of pages to return. The default value is 1.
PageSize Integer No The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
RequestId String The ID of the request.
VirtualBorderRouterSet JSON string

The detailed information of queried VBRs.

For more information, see VirtualBorderRouterSetType.

TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.

Error codes

See VPC API Error Center.


Request example

  1. ###### DescribeVirtualBorderRoutershttp://vpc.aliyuncs.com/?Action=DescribeVirtualBorderRouters
  2. &RegionId=cn-beijing
  3. &<CommonParameters>

Response example

JSON format

  1. {
  2. "PageNumber": 1,
  3. "VirtualBorderRouterSet": {
  4. "VirtualBorderRouterType": [
  5. {
  6. "LocalGatewayIp": "",
  7. "PeerGatewayIp": "",
  8. "Description": "",
  9. "PhysicalConnectionOwnerUid": "1231579085xxxx",
  10. "VlanId": 10,
  11. "RecoveryTime": "",
  12. "PhysicalConnectionStatus": "Enabled",
  13. "PhysicalConnectionId": "pc-2zeoaxkq3jotxxxxx",
  14. "RouteTableId": "vtb-2ze9hmd6yofwxxxxxx",
  15. "PeeringSubnetMask": "",
  16. "TerminationTime": "",
  17. "Name": "",
  18. "CreationTime": "2018-03-06T11:16:34Z",
  19. "ActivationTime": "2018-03-06T11:16:34Z",
  20. "CircuitCode": "",
  21. "Status": "active",
  22. "PhysicalConnectionBusinessStatus": "Normal",
  23. "VlanInterfaceId": "ri-2zeum6rgu058xxxxxx",
  24. "AccessPointId": "ap-cn-beijing-dx-A",
  25. "VbrId": "vbr-2zecmmvg5gvuxxxxxx"
  26. }
  27. "TotalCount": 1,
  28. "PageSize": 10,
  29. "RequestId": "98B24329-ADC9-4725-A5F8-6C1B282DA17D"
  30. }
Thank you! We've received your feedback.