查询路由表

最近更新时间:2024-03-12 02:02:37

我的收藏

1. 接口描述

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

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

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRouteTables。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
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 - (过滤条件)是否主路由表。
  • tag-key - String -是否必填:否 - (过滤条件)按照标签键进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。使用请参考示例2。
  • next-hop-type - String - 是否必填:否 - (过滤条件)按下一跳类型进行过滤。使用next-hop-type进行过滤时,必须同时携带route-table-id与vpc-id。
    目前我们支持的类型有:
    LOCAL: 本地路由
    CVM:公网网关类型的云服务器;
    VPN:VPN网关;
    DIRECTCONNECT:专线网关;
    PEERCONNECTION:对等连接;
    HAVIP:高可用虚拟IP;
    NAT:NAT网关;
    NORMAL_CVM:普通云服务器;
    EIP:云服务器的公网IP;
    CCN:云联网;
    LOCAL_GATEWAY:本地网关。

  • 示例值:[{"Name":"route-table-id", "Values": ["rtb-3yuu2t62"]},{"Name":"
    RouteTableIds.N Array of String 路由表实例ID,例如:rtb-azd4dt1c。
    Offset String 偏移量。
    示例值:0
    Limit String 返回数量,默认为20,最大值为100。
    示例值:1

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    示例值:16
    RouteTableSet Array of RouteTable 路由表对象。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

    查看路由表对象列表

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRouteTables
    <公共请求参数>
    
    {
        "Limit": "1",
        "Filters": [
            {
                "Values": [
                    "vpc-2at5y1pn"
                ],
                "Name": "vpc-id"
            },
            {
                "Values": [
                    "rtb-l2h8d7c2"
                ],
                "Name": "route-table-id"
            },
            {
                "Values": [
                    "true"
                ],
                "Name": "association.main"
            },
            {
                "Values": [
                    "TestRouteTable"
                ],
                "Name": "route-table-name"
            }
        ],
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "RouteTableSet": [
                {
                    "VpcId": "vpc-2at5y1pn",
                    "RouteTableId": "rtb-l2h8d7c2",
                    "RouteTableName": "TestRouteTable",
                    "AssociationSet": [],
                    "RouteSet": [
                        {
                            "RouteTableId": "rtb-l2h8d7c2",
                            "RouteId": 0,
                            "RouteItemId": "rti6-12345678",
                            "DestinationCidrBlock": "",
                            "DestinationIpv6CidrBlock": "2402:4e00:1000:810b::/64",
                            "GatewayType": "CCN",
                            "GatewayId": "ccn-12345678",
                            "RouteDescription": "",
                            "CreatedTime": "2017-06-30 19:52:03",
                            "RouteType": "USER",
                            "Enabled": true,
                            "PublishedToVbc": false
                        }
                    ],
                    "Main": false,
                    "TagSet": [
                        {
                            "Value": "test",
                            "Key": "test"
                        }
                    ],
                    "LocalCidrForCcn": [
                        {
                            "Cidr": "10.1.0.0/16",
                            "PublishedToVbc": true
                        }
                    ],
                    "CreatedTime": "2017-06-30 19:52:03"
                }
            ],
            "TotalCount": 1,
            "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
        }
    }

    示例2 查询绑定了标签的路由表列表

    查询绑定了标签的路由表列表

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRouteTables
    <公共请求参数>
    
    {
        "Limit": "1",
        "Filters": [
            {
                "Values": [
                    "shanghai"
                ],
                "Name": "tag:city"
            }
        ],
        "Offset": "0"
    }

    输出示例

    {
        "Response": {
            "RouteTableSet": [
                {
                    "VpcId": "vpc-2at5y1pn",
                    "RouteTableId": "rtb-l2h8d7c2",
                    "RouteTableName": "TestRouteTable",
                    "AssociationSet": [],
                    "RouteSet": [
                        {
                            "RouteTableId": "rtb-l2h8d7c2",
                            "RouteId": 14915,
                            "RouteItemId": "rti-12345678",
                            "DestinationCidrBlock": "169.254.64.0/23",
                            "DestinationIpv6CidrBlock": "",
                            "GatewayType": "NORMAL_CVM",
                            "GatewayId": "172.16.0.25",
                            "RouteDescription": "",
                            "CreatedTime": "2017-06-30 19:52:03",
                            "RouteType": "USER",
                            "Enabled": true,
                            "PublishedToVbc": false
                        }
                    ],
                    "TagSet": [
                        {
                            "Key": "city",
                            "Value": "shanghai"
                        }
                    ],
                    "LocalCidrForCcn": [
                        {
                            "Cidr": "10.1.0.0/16",
                            "PublishedToVbc": true
                        }
                    ],
                    "Main": false,
                    "CreatedTime": "2017-06-30 19:52:03"
                }
            ],
            "TotalCount": 1,
            "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError.ModuleError 内部模块错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameter.FilterNotDict 指定过滤条件不是键值对。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。
    UnsupportedOperation 操作不支持。