DescribeVRouters - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries VRouters.

Note

This API has been deprecated. We recommend migrating to Vpc(2016-04-28) - DescribeVRouters for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

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

get

*All Resource

*

vpc:VPC

None

Request parameters

Parameter	Type	Required	Description	Example
VRouterId	string	No	The ID of the VRouter.
RegionId	string	Yes	The ID of the region where the VRouter is deployed. You can call the `DescribeRegions` operation to query the latest region list.
PageNumber	integer	No	The page number. Default value: 1.
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.

Response elements

Element	Type	Description	Example
	object	The response body.
PageSize	integer	The number of entries per page.
RequestId	string	The request ID.
PageNumber	integer	The page number.
TotalCount	integer	The total number of entries returned.
VRouters	object	A wrapper object for the VRouter list.
VRouter	array<object>	An array of VRouter details.
	array<object>	Details of a VRouter.
VpcId	string	The ID of the VPC to which the VRouter belongs.
CreationTime	string	The time (in UTC) when the VRouter was created, in ISO 8601 format: `YYYY-MM-DDThh:mm:ssZ`.
VRouterId	string	The ID of the VRouter.
Description	string	The description of the VRouter.
VRouterName	string	The name of the VRouter.
RegionId	string	The region ID of the VRouter.
RouteTableIds	object	The IDs of the route tables that are associated with the VRouter.
RouteTableId	array	An array of route table IDs.
	string	The ID of a route table.

Examples

Success response

JSON format

{
  "PageSize": 0,
  "RequestId": "",
  "PageNumber": 0,
  "TotalCount": 0,
  "VRouters": {
    "VRouter": [
      {
        "VpcId": "",
        "CreationTime": "",
        "VRouterId": "",
        "Description": "",
        "VRouterName": "",
        "RegionId": "",
        "RouteTableIds": {
          "RouteTableId": [
            ""
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.