Queries the list of VRouters in a region.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeVRouters

The name of this action. Value: DescribeVRouters.

RegionId String Yes cn-hangzhou

The ID of the region to which the VRouter belongs. To query the region ID, call DescribeRegions.

VRouterId String No vrt-bp1lhl0taikrteen****

The ID of the VRouter to query.

PageNumber Integer No 1

The page number. Default value: 1.

PageSize Integer No 10

The number of entries per page in the case of a paged query result. Maximum value: 50. Default value: 10

Response parameters

Parameter Type Example value Description
RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

TotalCount Integer 1

The number of total entries.

PageNumber Integer 1

The current page number.

PageSize Integer 10

The number of entries per page.

VRouters Array

Details of VRouters.

RegionId String cn-hangzhou

The region to which the VRouter belongs.

VpcId String vpc-rj905wotv6y030t1****

The ID of the VPC to which the VRouter belongs.

VRouterName String doctest

The name of the VRouter.

Description String abc

The description of the VRouter.

VRouterId String vrt-rj98khsezfqpjrxmv****

The ID of the VRouter.

CreationTime String 2018-03-22T07:46:20Z

The time when the VRouter was created.

RouteTableIds List { "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }

The ID list of the route tables in the VRouter.

Examples

Request example

https://vpc.aliyuncs.com/?Action=DescribeVRouters
&RegionId=cn-hangzhou
&<Common request parameters>

Response example

XML format

<DescribeVRoutersResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <VRouters>
        <VRouter>
            <VRouterName></VRouterName>
            <RouteTableIds>
                <RouteTableId>vtb-bp1krxxzp0c29fmo****</RouteTableId>
            </RouteTableIds>
            <CreationTime>2018-12-06T06:11:55Z</CreationTime>
            <Description></Description>
            <RegionId>cn-hangzhou</RegionId>
            <VRouterId>vrt-bp1jcg5cmxjbl9xgc****</VRouterId>
            <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>
        </VRouter>
        <VRouter>
            <VRouterName></VRouterName>
            <RouteTableIds>
                <RouteTableId>vtb-bp1blq1oh0ybfnpm****</RouteTableId>
            </RouteTableIds>
            <CreationTime>2018-11-08T08:54:03Z</CreationTime>
            <Description></Description>
            <RegionId>cn-hangzhou</RegionId>
            <VRouterId>vrt-bp149ve7yeyvio4nc****</VRouterId>
            <VpcId>vpc-bp1aevy8sofi8mh1q****</VpcId>
        </VRouter>
    </VRouters>
    <PageSize>10</PageSize>
    <RequestId>EE4C2417-9437-4333-BDEB-8493F7AA7258</RequestId>
</DescribeVRoutersResponse>

JSON format

{
    "PageNumber": 1,
    "TotalCount": 1,
    "VRouters": {
        "VRouter": [
            {
                "VRouterName": "",
                "RouteTableIds": {
                    "RouteTableId": [
                        "vtb-rj9ybe3y0u41mmjsp****"
                    ]
                },
                "CreationTime": "2018-03-22T07:46:20Z",
                "Description": "",
                "RegionId": "us-west-1",
                "VRouterId": "vrt-rj98khsezfqpjrxmv****",
                "VpcId": "vpc-rj905wotv6y030t1z****"
            }
        ]
    },
    "PageSize": 10,
    "RequestId": "CB2793A8-845F-444C-8E93-76F1BBDF9C78"
}

Errors

For a list of error codes, visit the API Error Center.