tencent cloud

All product documents
Edge Computing Machine
DocumentationEdge Computing MachineAPI DocumentationRoute Table APIsDescribeRouteTables
DescribeRouteTables
Download PDF
Last updated: 2023-08-18 15:47:44
DescribeRouteTables
Last updated: 2023-08-18 15:47:44
Download PDF

1. API Description

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

This API is used to query the list of the objects in a route table.

A maximum of 20 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: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
RouteTableIds.N No Array of String Route table instance ID, such as rtb-azd4dt1c.
Filters.N No Array of Filter Filter. RouteTableIds and Filters cannot be specified at the same time.
route-table-id - String - (Filter) Route table instance ID.
route-table-name - String - (Filter) Route table name.
vpc-id - String - (Filter) VPC instance ID, such as vpc-f49l6u0z.
association.main - String - (Filter) Whether it is the main route table.
Offset No Integer Offset
Limit No Integer Limit
EcmRegion No String ECM region. If this parameter is left empty or not specified, it will indicate all regions.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible instances
RouteTableSet Array of RouteTable List of route tables
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing the list of objects in route table

Input Example

https://ecm.tencentcloudapi.com/?Action=DescribeRouteTables
&Offset=0
&Limit=1
&<Common request parameters>

Output Example

{
    "Response": {
        "RouteTableSet": [
            {
                "VpcId": "vpc-2at5y1pn",
                "RouteTableId": "rtb-l2h8d7c2",
                "RouteTableName": "TestRouteTable",
                "AssociationSet": [],
                "RouteSet": [
                    {
                        "RouteItemId": "rti-12345678",
                        "DestinationCidrBlock": "169.254.64.0/23",
                        "GatewayType": "NORMAL_CVM",
                        "GatewayId": "172.16.0.25",
                        "RouteDescription": ""
                    }
                ],
                "Main": false,
                "CreatedTime": "2020-11-30 19:52:03"
            }
        ],
        "TotalCount": 2,
        "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

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
FailedOperation.InternalOperationFailure Internal error.
InternalError Internal error.
InvalidParameter.Coexist The parameters cannot be specified at the same time.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.InvalidFilter The filter is invalid.
InvalidParameterValue.InvalidRegion The ECM region is invalid.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed The input parameter format is invalid.
ResourceNotFound The resource does not exist.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon