调用DescribeRouteTables查询路由表_专有网络VPC(VPC)-阿里云帮助中心

目前该API接口已标记为弃用，推荐使用替代API：Vpc(2016-04-28) - DescribeRouteTableList。

调用DescribeRouteTables接口查询路由表。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeRouteTables	list	RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId}	vpc:VBR vpc:VRouter	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	要查询的路由表所属的 VPC 的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	ap-southeast-6
VRouterId	string	否	要查询的路由器的 ID。说明 VRouterId，RouteTableId，RouterId 和 RouteTableName 参数至少需要输入一个，但是不能同时输入 VRouterId 和 RouterId 参数。	vrt-bp1lhl0taikrteen****
RouteTableId	string	否	要查询的路由表的 ID。说明 VRouterId，RouteTableId，RouterId 和 RouteTableName 参数至少需要输入一个，但是不能同时输入 VRouterId 和 RouterId 参数。	vtb-bp145q7glnuzdvzu2****
RouterType	string	否	要查询的路由表所属的路由器的类型。取值： VRouter（默认值）：VPC 路由器。 VBR：边界路由器。	VRouter
RouterId	string	否	要查询的路由表所属路由器的 ID。说明 VRouterId，RouteTableId，RouterId 和 RouteTableName 参数至少需要输入一个，但是不能同时输入 VRouterId 和 RouterId 参数。	vrt-bp1lhl0taikrteen8****
Type	string	否	要查询的路由条目的类型。取值： Custom：自定义路由。 System：系统路由。 BGP：BGP 路由。 CEN：云企业网 CEN（Cloud Enterprise Network）路由。 ECR：专线网关路由。	Custom
RouteTableName	string	否	要查询的路由表的名称。名称长度为 2~128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。说明 VRouterId，RouteTableId，RouterId 和 RouteTableName 参数至少需要输入一个，但是不能同时输入 VRouterId 和 RouterId 参数。	doctest
ResourceGroupId	string	否	要查询的路由表所属资源组的 ID。	rg-acfmxazb4ph****
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10

返回参数

名称	类型	描述	示例值
	object	每页包含的条目数。
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	DC668356-BCB4-42FD-9BC3-FA2B2E04B634
PageNumber	integer	当前页码。	1
TotalCount	integer	列表条目数。	1
RouteTables	array<object>	路由表列表详细信息。
RouteTable	object	路由表的创建时间。
CreationTime	string	路由表的创建时间。使用 UTC 时间，格式为`YYYY-MM-DDThh:mm:ssZ`。	2022-08-22T10:40:25Z
Status	string	路由表的状态。取值： Pending：配置中。 Available：可用。	Available
VRouterId	string	路由器的 ID。	vrt-bp1lhl0taikrteen****
RouteTableType	string	路由表的类型。取值： Custom：自定义路由表。 System：系统路由表。	Custom
ResourceGroupId	string	路由表所属资源组的 ID。	rg-acfmxazb4ph****
RouteTableId	string	路由表的 ID。	vtb-bp145q7glnuzdvzu2****
RouteEntrys	array<object>	路由条目信息。
RouteEntry	object	路由条目信息。
Type	string	路由条目的类型。取值： Custom：自定义路由。 System：系统路由。 BGP：BGP 路由。 CEN：云企业网 CEN（Cloud Enterprise Network）路由。 ECR：专线网关路由。	Custom
Status	string	路由条目的状态。取值： Pending：配置中。 Available：可用。 Modifying：修改中。	Available
NextHopType	string	下一跳类型。取值： Instance（默认值）：ECS 实例。 HaVip：高可用虚拟 IP。 VpnGateway：VPN 网关。 NatGateway：NAT 网关。 NetworkInterface：辅助弹性网卡。 RouterInterface：路由器接口。 IPv6Gateway：IPv6 网关。 Attachment：转发路由器。 Ipv4Gateway：IPv4 网关。 GatewayEndpoint：网关终端节点。 CenBasic：CEN 不支持转发路由器。 Ecr：专线网关。	Instance
RouteEntryName	string	路由条目的名称。名称长度为 2~128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。	name
RouteEntryId	string	路由条目的 ID。	rte-bp1mnnr2al0naomnp****
InstanceId	string	与下一跳相关联实例的实例 ID。	vpc-bp1t36rn9l53iwbsf****
RouteTableId	string	路由表 ID。	vtb-bp15w5q90d2rk3bww****
Description	string	路由条目的描述信息。描述长度为 2~256 个字符，必须以字母或中文开头，但不能以`http://`或`https://`开头。	RouteEntryDescription
DestinationCidrBlock	string	路由条目的目标网段。支持 IPv4 和 IPv6 的目标网段。需满足以下要求：目标网段不能指向 100.64.0.0/10 或被 100.64.0.0/10 包含。同一张路由表内的不同路由条目的目标网段不能相同。	192.168.2.0/24
NextHops	array<object>	下一跳信息。
NextHop	object	下一跳信息。
NextHopId	string	下一跳实例 ID。	vpn-bp10zyaph5cc8b7c7****
Weight	integer	路由条目的权重。	100
NextHopType	string	下一跳类型。取值： Instance：ECS 实例。 HaVip：高可用虚拟 IP。 VpnGateway：VPN 网关。 NatGateway：NAT 网关。 NetworkInterface：辅助弹性网卡。 RouterInterface：路由器接口。 IPv6Gateway：IPv6 网关。 Attachment：转发路由器。 Ipv4Gateway：IPv4 网关。 GatewayEndpoint：网关终端节点。 CenBasic：CEN 不支持转发路由器。 Ecr：专线网关。	Instance
Enabled	integer	路由是否可用。取值： 0：不可用。 1：可用。	1
VSwitchIds	array	交换机 ID。
VSwitchId	string	交换机 ID。	vsw-bp12mw1f8k3jgygk9****

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteTables": {
    "RouteTable": [
      {
        "CreationTime": "2022-08-22T10:40:25Z",
        "Status": "Available",
        "VRouterId": "vrt-bp1lhl0taikrteen****",
        "RouteTableType": "Custom",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "RouteTableId": "vtb-bp145q7glnuzdvzu2****",
        "RouteEntrys": {
          "RouteEntry": [
            {
              "Type": "Custom",
              "Status": "Available",
              "NextHopType": "Instance",
              "RouteEntryName": "name",
              "RouteEntryId": "rte-bp1mnnr2al0naomnp****",
              "InstanceId": "vpc-bp1t36rn9l53iwbsf****",
              "RouteTableId": "vtb-bp15w5q90d2rk3bww****",
              "Description": "RouteEntryDescription",
              "DestinationCidrBlock": "192.168.2.0/24",
              "NextHops": {
                "NextHop": [
                  {
                    "NextHopId": "vpn-bp10zyaph5cc8b7c7****",
                    "Weight": 100,
                    "NextHopType": "Instance",
                    "Enabled": 1
                  }
                ]
              }
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp12mw1f8k3jgygk9****"
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidVRouterId.NotFound	Specified virtual router does not exist.	该路由器不存在，请您检查输入的路由器是否正确。
400	OperationFailed.DescribeCenRoute	An error occurred while querying the CEN route entry.	查询cen路由异常。
400	OperationFailed.VRouterNotExist	Operation failed because the VRouter does not exist.	操作失败因为虚拟路由器不存在。

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

变更历史

变更时间	变更内容概要	操作
2024-06-12	OpenAPI 变更为 deprecated，即将下线、OpenAPI 错误码发生变更	查看变更详情
2023-09-25	OpenAPI 错误码发生变更	查看变更详情
2023-09-06	OpenAPI 错误码发生变更	查看变更详情
2023-08-09	OpenAPI 描述信息更新	查看变更详情