调用DescribeVRouters查询指定地域的路由器列表_专有网络VPC(VPC)-阿里云帮助中心

调用DescribeVRouters接口查询指定地域的路由器列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeVRouters	list	VRouter `acs:vpc:{#regionId}:{#accountId}:vrouter/`	vpc:VPC	无

请求参数

名称	类型	必填	描述	示例值
VRouterId	string	否	要查询的路由器的 ID。	vrt-bp1lhl0taikrteen****
RegionId	string	是	要查询的路由器所属地域的 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10

返回参数

名称	类型	描述	示例值
	object
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目数。	1
VRouters	array<object>	路由器的详细信息。
VRouter	object
VpcId	string	路由器所属 VPC 的 ID。	vpc-rj905wotv6y030t1****
CreationTime	string	路由器的创建时间。	2018-03-22T07:46:20Z
VRouterId	string	路由器的 ID。	vrt-rj98khsezfqpjrxmv****
Description	string	路由器的描述信息。	abc
VRouterName	string	路由器的名称。	doctest
RegionId	string	路由器所属的地域。	cn-hangzhou
RouteTableIds	array
RouteTableId	string	路由器中的路由表的 ID。	{ "RouteTableId": [ "vtb-rj9ybe3y0u41mmjsp****"] }

示例

正常返回示例

JSON格式

{
  "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****\"] }"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-07-31	OpenAPI 错误码发生变更	查看变更详情
2023-08-09	OpenAPI 描述信息更新	查看变更详情