查询路由列表

最近更新时间:2018-10-26 15:02:05

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeRouteTables)用于查询路由表。

默认接口请求频率限制:100次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRouteTables
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
RouteTableIds.N Array of String 路由表实例ID,例如:rtb-azd4dt1c。
Filters.N Array of Filter 过滤条件,参数不支持同时指定RouteTableIds和Filters。
  • route-table-id - String - (过滤条件)路由表实例ID。
  • route-table-name - String - (过滤条件)路由表名称。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • association.main - String - (过滤条件)是否主路由表。
  • Offset String 偏移量。
    Limit String 请求对象个数。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    RouteTableSet Array of RouteTable 路由表对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看路由表对象列表

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeRouteTables
    &Version=2017-03-12
    &Offset=0
    &Limit=1
    &Filters.0.Name=route-table-id
    &Filters.0.Values.0=rtb-l2h8d7c2
    &Filters.1.Name=vpc-id
    &Filters.1.Values.0=vpc-2at5y1pn
    &Filters.2.Name=route-table-name
    &Filters.2.Values.0=TestRouteTable
    &Filters.3.Name=association.main
    &Filters.3.Values.0=true
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b",
        "RouteTableSet": [
          {
            "AssociationSet": [],
            "CreatedTime": "2017-06-30 19:52:03",
            "Main": false,
            "RouteSet": [
              {
                "DestinationCidrBlock": "169.254.64.0/23",
                "GatewayId": "172.16.0.25",
                "GatewayType": "NORMAL_CVM",
                "RouteDescription": "",
                "RouteId": 14915
              },
              {
                "DestinationCidrBlock": "10.254.64.0/24",
                "GatewayId": "172.16.0.26",
                "GatewayType": "NORMAL_CVM",
                "RouteDescription": "",
                "RouteId": 14916
              },
              {
                "DestinationCidrBlock": "10.254.100.0/24",
                "GatewayId": "172.16.0.26",
                "GatewayType": "NORMAL_CVM",
                "RouteDescription": "whoIam",
                "RouteId": 14917
              },
              {
                "DestinationCidrBlock": "10.200.0.0/18",
                "GatewayId": "pcx-4n2m594s",
                "GatewayType": "PEERCONNECTION",
                "RouteDescription": "bb",
                "RouteId": 16642
              }
            ],
            "RouteTableId": "=rtb-l2h8d7c2",
            "RouteTableName": "TestRouteTable",
            "VpcId": "vpc-2at5y1pn"
          }
        ],
        "TotalCount": 16
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.Malformed 入参格式不合法。
    ResourceNotFound 资源不存在。