DescribeVRouters-阿里云帮助中心

Calls the DescribeVRouters operation to query the list of vRouters in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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 to query.	vrt-bp1lhl0taikrteen****
RegionId	string	Yes	The ID of the region where the vRouter resides. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Maximum value: 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
PageNumber	integer	The current page number.	1
TotalCount	integer	The total number of entries.	1
VRouters	object
VRouter	array<object>	The details of the vRouter.
	array<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	object
RouteTableId	array	The IDs of the route tables.
	string	The ID of the route table.	{ "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }

Examples

Success response

JSON format

{
  "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

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.