Queries VRouters in a region.

Debug

By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs.

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 VPC belongs.

To query the region ID, call DescribeRegions.

VRouterId String No vrt-bp1lhl0taikrteen80oxx

The ID of the VRouter.

PageNumber Integer No 10

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

PageSize Integer No 10

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

Response parameters

Parameter Type Example value Description
VRouters N/A

A list of VRouters.

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

The time when the VRouter was created.

 └Description String This is my VRouter.

The description of the VRouter.

 └RegionId String us-west-1

The region where the VPC belongs.

 └RouteTableIds N/A { "RouteTableId": [ "vtb-rj9ybe3y0u41mmjspmop0" ] }

The ID of the route table of the VRouter.

 └VRouterId String vrt-rj98khsezfqpjrxmvl7cy

The ID of the VRouter.

 └VRouterName String doctest

The name of the VRouter.

 └VpcId String vpc-rj905wotv6y030t1zz5vl

The ID of the VPC to which the VRouter belongs.

TotalCount Integer 1

The number of queried entries.

PageNumber Integer 1

The current page number.

PageSize Integer 2

The number of entries per page.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Request example


https://vpc.aliyuncs.com/?RegionId=cn-hangzhou
&<CommonParameters>
Response example
  • XML format

    <DescribeVRoutersResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>2</TotalCount>
      <VRouters>
        <VRouter>
          <VRouterName/>
          <RouteTableIds>
            <RouteTableId>vtb-bp1krxxzp0c29fmontbal</RouteTableId>
          </RouteTableIds>
          <CreationTime>2018-12-06T06:11:55Z</CreationTime>
          <Description/>
          <RegionId>cn-hangzhou</RegionId>
          <VRouterId>vrt-bp1jcg5cmxjbl9xgc58bw</VRouterId>
          <VpcId>vpc-bp1qpo0kug3a20qqe9h7v</VpcId>
        </VRouter>
        <VRouter>
          <VRouterName/>
          <RouteTableIds>
            <RouteTableId>vtb-bp1blq1oh0ybfnpm1bh20</RouteTableId>
          </RouteTableIds>
          <CreationTime>2018-11-08T08:54:03Z</CreationTime>
          <Description/>
          <RegionId>cn-hangzhou</RegionId>
          <VRouterId>vrt-bp149ve7yeyvio4ncklxz</VRouterId>
          <VpcId>vpc-bp1aevy8sofi8mh1qc5cm</VpcId>
        </VRouter>
      </VRouters>
      <PageSize>10</PageSize>
      <RequestId>EE4C2417-9437-4333-BDEB-8493F7AA7258</RequestId>
    </DescribeVRoutersResponse>
    
  • JSON format

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

Error codes

See common error codes