全部产品
Search
文档中心

专有网络 VPC:DescribeRouteTableList - 查询路由表

更新时间:Nov 27, 2024

调用DescribeRouteTableList接口查询路由表列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeRouteTableListlist
*RouteTable
acs:vpc:{#regionId}:{#accountId}:routetable/*
  • vpc:VRouter
  • vpc:VBR

请求参数

名称类型必填描述示例值
RouterTypestring

要查询的路由表所属的路由器的类型。取值:

  • VRouter(默认值):VPC 路由器。

  • VBR:边界路由器。

VRouter
RouterIdstring

要查询的路由表所属路由器的 ID。

vrt-bp1lhl0taikrteen8****
VpcIdstring

要查询的路由表所属的 VPC 的 ID。

指定该参数后,RouterType 参数的值自动设置为 VRouter

vpc-bp15zckdt37pq72****
RouteTableIdstring

要查询的路由表的 ID。

vtb-bp145q7glnuzdvzu2****
RouteTableNamestring

要查询的路由表的名称。

doctest
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
ResourceGroupIdstring

要查询的路由表所属资源组的 ID。

rg-acfmxazb4ph****
RegionIdstring

要查询的路由表所属的 VPC 的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

ap-southeast-6
Tagarray<object>

资源的标签。

object

标签。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua
RouteTableTypestring

路由表的类型。

  • System:系统路由表。

  • Custom:自定义路由表。

System

返回参数

名称类型描述示例值
object

查询的路由表详细信息。

RequestIdstring

请求 ID。

DC668356-BCB4-42FD-9BC3-FA2B2E04B634
PageSizeinteger

每页包含的条目数。

10
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目数。

1
RouterTableListarray<object>

路由表列表详细信息。

RouterTableListTypeobject

路由表列表详细信息

VpcIdstring

路由表所属的 VPC 的 ID。

vpc-bp15zckdt37pq72****
CreationTimestring

路由表的创建时间。

2021-08-22T10:40:25Z
Statusstring

路由表的状态。取值:

  • Pending:创建中。

  • Available:可用。

  • Deleting:删除中。

Available
RouterIdstring

路由表所属的路由器 ID。

vrt-bp1lhl0taikrteen8****
AssociateTypestring

路由表绑定的云资源类型。取值:

  • VSwitch:交换机。

  • Gateway:IPv4 网关。

VSwitch
RouteTableIdstring

路由表的 ID。

vtb-bp145q7glnuzdvzu2****
OwnerIdlong

路由表所属阿里云账号 ID。

253460731706911258
Descriptionstring

路由表的描述。

This is Route Table.
RouteTableTypestring

路由表的类型。取值:

  • Custom:自定义路由表。

  • System:系统路由表。

System
ResourceGroupIdstring

路由表所属资源组的 ID。

rg-acfmxazb4ph****
RouterTypestring

路由表所属路由器的类型。取值:

  • VRouter:VPC 路由器。

  • VBR:边界路由器。

VRouter
RouteTableNamestring

路由表的名称。

doctest
Tagsarray<object>

路由表的标签。

Tagobject

路由表的标签。

Keystring

路由表绑定的标签键。

type
Valuestring

路由表绑定的标签键对应的值。

ingress
VSwitchIdsarray

交换机列表信息。

VSwitchIdstring

交换机 ID。

vsw-bp12mw1f8k3jgygk9****
GatewayIdsarray

IPv4 网关详细信息。

GatewayIdsstring

IPv4 网关详细信息。

ipv4gw-5tsnc6s4ogsedtp3k****
RoutePropagationEnableboolean

路由表是否接收传播路由。取值:

  • true:路由表接收。
  • false:路由表不接收。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "DC668356-BCB4-42FD-9BC3-FA2B2E04B634",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 1,
  "RouterTableList": {
    "RouterTableListType": [
      {
        "VpcId": "vpc-bp15zckdt37pq72****",
        "CreationTime": "2021-08-22T10:40:25Z",
        "Status": "Available",
        "RouterId": "vrt-bp1lhl0taikrteen8****",
        "AssociateType": "VSwitch",
        "RouteTableId": "vtb-bp145q7glnuzdvzu2****",
        "OwnerId": 253460731706911260,
        "Description": "This is Route Table.",
        "RouteTableType": "System",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "RouterType": "VRouter",
        "RouteTableName": "doctest",
        "Tags": {
          "Tag": [
            {
              "Key": "type",
              "Value": "ingress"
            }
          ]
        },
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp12mw1f8k3jgygk9****"
          ]
        },
        "GatewayIds": {
          "GatewayIds": [
            "ipv4gw-5tsnc6s4ogsedtp3k****"
          ]
        },
        "RoutePropagationEnable": true
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidTagKeyThe tag keys are not valid.无效的标签索引
400InvalidTagValueThe tag values are not valid.无效的标签值
400IellgalParameter.OwnerAccountThe specified parameter OwnerAccount is not valid.指定参数 OwnerAccount 不合法
403ForbbidenUser not authorized to operate on the specified resource.用户没有权限操作指定的资源。
403Abs.InvalidPayTypeSpecified pay type is not valid.-
403Abs.InstanceNotExistSpecified instance not exist.-
403Abs.ForbiddenSpecified instance cannot change pay type.-
403Abs.InvalidPayPeriodSpecified pay period not valid.-

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

变更历史

变更时间变更内容概要操作
2024-01-05OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-11-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-08-14OpenAPI 错误码发生变更查看变更详情
2023-08-03OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情