Tencent Cloud

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

DescribeRouteTables

Last updated: 2024-11-25 20:04:03

Download PDF

1. API Description

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

This API is used to query route tables.

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

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 Params. The value used for this API: DescribeRouteTables.
Version	Yes	String	Common Params. The value used for this API: 2017-03-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
Filters.N	No	Array of Filter	Filter condition. `RouteTableIds` and `Filters` cannot be specified 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. Use a specific tag key to replace `tag-key`. See Example 2 for the detailed usage.
RouteTableIds.N	No	Array of String	The route table instance ID, such as `rtb-azd4dt1c`.
Offset	No	String	Offset.
Limit	No	String	The number of request objects.
NeedRouterInfo	No	Boolean

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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Viewing the list of objects in route table

This example shows you how to query the list of objects in route table

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRouteTables
<Common request parameters>

{
    "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"
}

Output Example

{
    "Response": {
        "RouteTableSet": [
            {
                "VpcId": "vpc-2at5y1pn",
                "RouteTableId": "rtb-l2h8d7c2",
                "RouteTableName": "TestRouteTable",
                "AssociationSet": [],
                "RouteSet": [
                    {
                        "RouteId": 0,
                        "RouteItemId": "rti6-12345678",
                        "DestinationCidrBlock": "",
                        "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,
                "TagSet": [
                    {
                        "Value": "test",
                        "Key": "test"
                    }
                ],
                "LocalCidrForCcn": [
                    {
                        "Cidr": "10.1.0.0/16",
                        "PublishedToVbc": true
                    }
                ],
                "CreatedTime": "2017-06-30 19:52:03"
            }
        ],
        "TotalCount": 16,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

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

This example shows you how to query the list of route tables bound with the specified tag.

Input Example

POST / HTTP/1.1
Host: vpc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRouteTables
<Common request parameters>

{
    "Limit": "1",
    "Filters": [
        {
            "Values": [
                "shanghai"
            ],
            "Name": "tag:city"
        }
    ],
    "Offset": "0"
}

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"
                    }
                ],
                "LocalCidrForCcn": [
                    {
                        "Cidr": "10.1.0.0/16",
                        "PublishedToVbc": true
                    }
                ],
                "Main": false,
                "CreatedTime": "2017-06-30 19:52:03"
            }
        ],
        "TotalCount": 16,
        "RequestId": "74883e1b-5901-46de-ae1e-d6e2cf591c5b"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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
InternalError.ModuleError	Internal module error
InvalidParameter.Coexist	The parameters cannot be specified at the same time.
InvalidParameter.FilterInvalidKey	The specified filter condition does not exist.
InvalidParameter.FilterNotDict	The specified filter condition should be a key-value pair.
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.NotUtf8EncodingError
InvalidParameterValue.Range	The parameter value is not in the specified range.
ResourceNotFound	The resource does not exist.
UnsupportedOperation	Unsupported operation.

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support

tencent cloud

Recent Pages

DescribeRouteTables

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Viewing the list of objects in route table

Input Example

Output Example

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

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?

tencent cloud

Sign Up

Log in

Recent Pages

DescribeRouteTables

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Viewing the list of objects in route table

Input Example

Output Example

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

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

Was this page helpful?

Was this page helpful?