DescribeVRouters

Description

call the DescribeVRouters interface to query the list of routers in the specified region.

Request Method

POST

Request Path

/apsara/route/Vpc/DescribeVRouters

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
VRouterId	BODY	string	No	vrt-bp1lhl0taikrteen****	ID of router to query.
PageSize	BODY	integer	No	10	The number of rows per page during paging query, the maximum value is 50, the default value is 10.
PageNumber	BODY	integer	No	1	page number of the list, the default value is 1.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
RegionId	BODY	string	Yes	cn-qingdao-env17-d01	ID of the region to which the router to be queried belongs. You can obtain the region ID by calling the DescribeRegions interface.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
VRouters	array of vrouter	No sample value for this parameter.	router details.
Description	string	abc	router description information.
PageSize	integer	10	Number of entries per page.
RequestId	string	0ED8D006-F706-4D23-88ED-E11ED28DCAC0	request ID.
VRouter		No sample value for this parameter.	No description for this parameter.
VRouterName	string	doctest	the name of the router.
VRouterId	string	vrt-rj98khsezfqpjrxmv****	router ID.
TotalCount	integer	1	Number of entries in the list.
VpcId	string	vpc-rj905wotv6y030t1****	ID of the VPC to which the router belongs.
RouteTableIds	list	{"RouteTableId":["vtb-rj9ybe3y0u41mmjsp****"]}	ID of routing table in router.
PageNumber	integer	1	current page number.
CreationTime	string	2018-03-22T07:46:20Z	the creation time of the router.
RegionId	string	cn-hangzhou	the region to which the router belongs.

Example

Successful Response example

{
 "VRouters":"",
 "Description":"abc",
 "PageSize":"10",
 "RequestId":"0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
 "VRouter":"",
 "VRouterName":"doctest",
 "VRouterId":"vrt-rj98khsezfqpjrxmv****",
 "TotalCount":"1",
 "VpcId":"vpc-rj905wotv6y030t1****",
 "RouteTableIds":
 {
  "RouteTableId":
  [
   "vtb-rj9ybe3y0u41mmjsp****"
  ]

 },
 "PageNumber":"1",
 "CreationTime":"2018-03-22T07:46:20Z",
 "RegionId":"cn-hangzhou"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}