edit-icon download-icon


Last Updated: Apr 12, 2018


Queries the list of router interfaces.

Currently supported filters include RouterInterfaceId, RouterId, RouterType, RouterInterfaceOwnerId, OppositeInterfaceId, OppositeRouterType, OppositeRouterId, OppositeInterfaceOwnerId, Status, and Name.

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: DescribeRouterInterfaces

RegionId String Yes

The region where the router interface is located.

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:

  • RouterInterfaceId: The ID of the router interface.

  • RouterId: The ID of the VRouter or VBR.

  • RouterType: The type of the router associated with the router interface.

  • RouterInterfaceOwnerId: The owner ID of the router interface.

  • OppositeInterfaceId: The ID of the peer router interface.

  • OppositeRouterType: The type of the router associated with the peer router interface.

  • OppositeRouterId: The ID of the peer router.

  • OppositeInterfaceOwnerId: The owner ID of the peer router interface.

  • Status: The status of the router interface.

  • Name: The name of the router interface.

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 entries 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.
TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.
Instances JSON string

The detailed information of the queried router interfaces.

For more information, see RouterInterfaceSetType.

Error codes

See VPC API Error Center.


Request example

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

Response example

  1. {
  2. "PageNumber": 1,
  3. "TotalCount": 1,
  4. "PageSize": 10,
  5. "RequestId": "3F12D2E8-0B95-46F3-BE89-C2D69BF134D0",
  6. "RouterInterfaceSet": {
  7. "RouterInterfaceType": [
  8. {
  9. "ChargeType": "AfterPay",
  10. "OppositeInterfaceBusinessStatus": "Normal",
  11. "RouterInterfaceId": "ri-2ze7fbuohm7pcxxxxx",
  12. "OppositeInterfaceStatus": "Active",
  13. "Spec": "Negative",
  14. "OppositeAccessPointId": "ap-cn-beijing-dx-A",
  15. "OppositeInterfaceOwnerId": "12315790855xxxxx",
  16. "OppositeInterfaceSpec": "Large.1",
  17. "CreationTime": "2018-03-01T07:19:31Z",
  18. "RouterType": "VRouter",
  19. "Status": "Active",
  20. "OppositeRouterType": "VBR",
  21. "OppositeRouterId": "vbr-2zee2e2cwetx4xxxxxx",
  22. "OppositeInterfaceId": "ri-2ze07ad6sgzixxxxx",
  23. "VpcInstanceId": "vpc-2zefsil0x93dguxxxxx",
  24. "RouterId": "vrt-2zepuy8qbrq6xxxxx",
  25. "ConnectedTime": "2018-03-01T07:19:32Z",
  26. "OppositeRegionId": "cn-beijing",
  27. "BusinessStatus": "Normal",
  28. "Role": "AcceptingSide",
  29. "EndTime": "2999-09-08T16:00:00Z"
  30. }
  31. ]
  32. }
  33. }
Thank you! We've received your feedback.