edit-icon download-icon

DescribeVRouters

Last Updated: Apr 27, 2018

Description

Query VRouters in a specified region.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeVRouters

VRouterId String No The ID of the VRouter.
RegionId String Yes

The ID of the region where the VRouter is located.

You can obtain the region ID by calling DescribeRegions API.

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 default value is 10.

Response parameters

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

The detailed information of queried VRouters.

For more information, see VRouterSetType.

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.

Examples

Request example

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

Response example

XML format

  1. <DescribeVRoutersResponse>
  2. <RequestId>C2C6EF61-53B7-4071-A87D-B42F1F17FA5A</RequestId>
  3. <VRouters>
  4. <VRouter>
  5. <VpcId>vpc-257gq642n</VpcId>
  6. <VRouterName></VRouterName>
  7. <Description></Description>
  8. <VRouterId>vrt-25bezkd03</VRouterId>
  9. <RouteTableIds>
  10. <RouteTableId>vtb-25wm68mnh</RouteTableId>
  11. </RouteTableIds>
  12. <CreationTime>2014-10-29T13:30:19Z</CreationTime>
  13. </VRouter>
  14. </VRouters>
  15. </DescribeVRoutersResponse>

JSON format

  1. {
  2. "PageNumber": 1,
  3. "PageSize": 10,
  4. "RequestId": "C2C6EF61-53B7-4071-A87D-B42F1F17FA5A",
  5. "TotalCount": 1,
  6. "VRouters": {
  7. "VRouter": [
  8. {
  9. "CreationTime": "2014-10-29T13:30:19Z",
  10. "Description": "",
  11. "RegionId": "cn-beijing",
  12. "RouteTableIds": {
  13. "RouteTableId": [
  14. "vtb-25wm68mnh"
  15. ]
  16. },
  17. "VRouterId": "vrt-25bezkd03",
  18. "VRouterName": "",
  19. "VpcId": "vpc-257gq642n"
  20. }
  21. ]
  22. }
  23. }
Thank you! We've received your feedback.