DescribeVRouters - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries vRouters in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeVRouters	list	VRouter acs:vpc:{#regionId}:{#accountId}:vrouter/*	vpc:VPC	none

Request parameters

Parameter	Type	Required	Description	Example
VRouterId	string	No	The ID of the vRouter.	vrt-bp1lhl0taikrteen****
RegionId	string	Yes	The region ID of the vRouter that you want to query. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The number of entries returned.	1
VRouters	array<object>	The details about the vRouters.
	object
VpcId	string	The ID of the virtual private cloud (VPC) to which the vRouter belongs.	vpc-rj905wotv6y030t1****
CreationTime	string	The time when the vRouter was created.	2018-03-22T07:46:20Z
VRouterId	string	The ID of the vRouter.	vrt-rj98khsezfqpjrxmv****
Description	string	The description of the vRouter.	abc
VRouterName	string	The name of the vRouter.	doctest
RegionId	string	The region to which the vRouter belongs.	cn-hangzhou
RouteTableIds	array	The ID of the route table in the vRouter.
	string		{ "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "PageNumber": 1,
  "TotalCount": 1,
  "VRouters": {
    "VRouter": [
      {
        "VpcId": "vpc-rj905wotv6y030t1****",
        "CreationTime": "2018-03-22T07:46:20Z",
        "VRouterId": "vrt-rj98khsezfqpjrxmv****",
        "Description": "abc",
        "VRouterName": "doctest",
        "RegionId": "cn-hangzhou",
        "RouteTableIds": {
          "RouteTableId": [
            "{ \"RouteTableId\": [ \"vtb-rj9ybe3y0u41mmjsp****\"] }"
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-07-31	The Error code has changed	View Change Details
2023-08-09	API Description Update	View Change Details