tencent cloud

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

1. API Description

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

This API (DeleteRoutes) is used to delete routing policies in batches from a route table.

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: DeleteRoutes.
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.
RouteTableId Yes String Route table instance ID.
Routes.N No Array of Route Routing policy object. Only the RouteId field is required when deleting a routing policy.

3. Output Parameters

Parameter Name Type Description
RouteSet Array of Route Details of the routing policy that has been deleted.
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 Deleting routes from a route table

This example shows you how to delete routes from a route table.

Input Example

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

{
    "RouteTableId": "rtb-n0yejvje",
    "Routes": [
        {
            "RouteId": 1,
            "DestinationCidrBlock": "192.241.0.0/24",
            "GatewayType": "EIP",
            "GatewayId": "vpc-pymolayx",
            "RouteDescription": "TEST",
            "Enabled": true,
            "RouteType": "USER",
            "RouteTableId": "rtb-n0yejvje",
            "DestinationIpv6CidrBlock": "201::/16",
            "RouteItemId": "rti-pbta2ruf",
            "PublishedToVbc": true,
            "CreatedTime": "2020-09-22 00:00:00"
        }
    ]
}

Output Example

{
    "Response": {
        "RouteSet": [
            {
                "RouteId": 1,
                "DestinationCidrBlock": "192.241.0.0/24",
                "GatewayType": "EIP",
                "GatewayId": "vpc-pymolayx",
                "RouteDescription": "TEST",
                "Enabled": true,
                "RouteType": "USER",
                "RouteTableId": "rtb-n0yejvje",
                "DestinationIpv6CidrBlock": "201::/16",
                "RouteItemId": "rti-pbta2ruf",
                "PublishedToVbc": true,
                "CreatedTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "10098418-f013-4d3e-855b-e086f0544b44"
    }
}

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
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
ResourceNotFound The resource does not exist.
UnknownParameter.WithGuess Unknown parameter. Try similar parameters.
UnsupportedOperation.DisabledNotifyCcn The specified routing policy cannot be re-published to CCN. Please first withdraw it from CCN.
UnsupportedOperation.SystemRoute System route. Operation is prohibited.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback