International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Virtual Private Cloud
    Documentation
    Download PDF

    DescribeRouteTables

    Last updated: 2020-09-10 17:59:17
    Download PDF

    1. API Description

    Domain name for API request: vpc.tencentcloudapi.com.

    This API (DescribeRouteTables) is used to query route tables.

    A maximum of 100 requests can be initiated per second for this API.

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: DescribeRouteTables.
    Version Yes String Common parameter. The value used for this API: 2017-03-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    RouteTableIds.N No Array of String The route table instance ID, such as rtb-azd4dt1c.
    Filters.N No Array of Filter Filter condition. RouteTableIds and Filters cannot be speified at the same time.
  • route-table-id - String - (Filter condition) Route table instance ID.
  • route-table-name - String - (Filter condition) Route table name.
  • vpc-id - String - (Filter condition) VPC instance ID, such as vpc-f49l6u0z.
  • association.main - String - (Filter condition) Whether it is the main route table.
  • tag-key - String - Required: No - (Filter condition) Filter by tag key.
  • tag:tag-key - String - Required: No - (Filter condition) Filter by tag key-value pair. The tag-key is replaced with the specific tag key. For usage, refer to case 2.
    		•
    Offset No String Offset.
    Limit No String The number of request objects.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of eligible instances.
    RouteTableSet Array of RouteTable Route table object.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Viewing the object list of the route table

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeRouteTables
&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
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RouteTableSet": [
      {
        "VpcId": "vpc-2at5y1pn",
        "RouteTableId": "rtb-l2h8d7c2",
        "RouteTableName": "TestRouteTable",
        "AssociationSet": [],
        "RouteSet": [
          {
            "RouteId": 0,
            "RouteItemId": "rti6-12345678",
            "DestinationIpv6CidrBlock": "2402:4e00:1000:810b::/64",
            "GatewayType": "CCN",
            "GatewayId": "ccn-12345678",
            "RouteDescription": ""
          },
          {
            "RouteId": 14915,
            "RouteItemId": "rti-12345678",
            "DestinationCidrBlock": "169.254.64.0/23",
            "GatewayType": "NORMAL_CVM",
            "GatewayId": "172.16.0.25",
            "RouteDescription": ""
          },
          {
            "RouteId": 14916,
            "RouteItemId": "rti-22345678",
            "DestinationCidrBlock": "10.254.64.0/24",
            "GatewayType": "NORMAL_CVM",
            "GatewayId": "172.16.0.26",
            "RouteDescription": ""
          },
          {
            "RouteId": 14917,
            "RouteItemId": "rti-32345678",
            "DestinationCidrBlock": "10.254.100.0/24",
            "GatewayType": "NORMAL_CVM",
            "GatewayId": "172.16.0.26",
            "RouteDescription": "whoIam"
          },
          {
            "RouteId": 16642,
            "RouteItemId": "rti-42345678",
            "DestinationCidrBlock": "10.200.0.0/18",
            "GatewayType": "PEERCONNECTION",
            "GatewayId": "pcx-4n2m594s",
            "RouteDescription": "bb"
          }
        ],
        "Main": false,
        "CreatedTime": "2017-06-30 19:52:03"
      }
    ],
    "TotalCount": 16,
    "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
  }
}

    Example2 Querying the list of route tables bound to the specified tag

    Input Example

    https://vpc.tencentcloudapi.com/?Action=DescribeRouteTables
&Offset=0
&Limit=1
&Filters.0.Name=tag:city
&Filters.0.Values.0=shanghai
&<Common request parameters>

    Output Example

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

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    ResourceNotFound The resource does not exist.

    Was this page helpful?

    Confirm

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Hide
    Submit a TicketContact sales
    Help
    tencent
    Copyright © 2013-2020 Tencent Cloud. All Rights Reserved.
    Privacy PolicyTerms of ServiceCookie Policy