tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ReplaceRoutes

Last updated: 2023-05-19 17:19:00

1. API Description

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

This API (ReplaceRoutes) is used to modify a specified routing policy by its ID (RouteId). Batch modification is supported.

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: ReplaceRoutes.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
RouteTableId Yes String The route table instance ID, such as rtb-azd4dt1c.
Routes.N Yes Array of Route Routing policy object. The routing policy ID (RouteId) must be specified.

3. Output Parameters

Parameter Name Type Description
OldRouteSet Array of Route Old routing policy
NewRouteSet Array of Route New routing policy
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Replacing a route

This example shows you how to replace a route.

Input Example

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

{
    "RouteTableId": "rtb-n0yejvje",
    "Routes": [
        {
            "RouteId": 17125,
            "DestinationCidrBlock": "192.168.0.0/16",
            "GatewayType": "NORMAL_CVM",
            "GatewayId": "172.16.16.37",
            "RouteDescription": "abc",
            "Enabled": true,
            "RouteType": "abc",
            "RouteTableId": "abc",
            "DestinationIpv6CidrBlock": "abc",
            "RouteItemId": "abc",
            "PublishedToVbc": true,
            "CreatedTime": "2020-09-22 00:00:00"
        }
    ]
}

Output Example

{
    "Response": {
        "NewRouteSet": [
            {
                "DestinationCidrBlock": "172.16.16.37/22",
                "RouteTableId": "rtb-n0yejvje",
                "RouteDescription": "",
                "GatewayType": "NORMAL_CVM",
                "GatewayId": "pcx-n9vkqrtm"
            }
        ],
        "RequestId": "3f934a21-2786-44af-a421-38ee6c6e1fae",
        "OldRouteSet": [
            {
                "DestinationCidrBlock": "172.16.16.37/21",
                "RouteTableId": "rtb-n0yejvje",
                "RouteDescription": "",
                "GatewayType": "PEERCONNECTION",
                "GatewayId": "pcx-n9vkqrtk"
            }
        ]
    }
}

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 Incorrect parameter value.
InvalidParameterValue.CidrNotInPeerVpc The destination IP address range is not within the CIDR range of the the customer VPC.
InvalidParameterValue.Duplicate The input parameter already exists.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.VpcCidrConflict Destination IP address range conflicts with CIDR of the current VPC.
LimitExceeded Quota limit is reached.
ResourceNotFound The resource does not exist.
UnknownParameter.WithGuess Unknown parameter. Try similar parameters.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.CdcSubnetNotSupportUnLocalGateway CDC subnet can only create a route to the local gateway.
UnsupportedOperation.ConflictWithDockerRoute The IP range overlaps with that of the TKE container under the VPC.
UnsupportedOperation.Ecmp ECMP is not supported.
UnsupportedOperation.NormalSubnetNotSupportLocalGateway The specified subnet does not support creating a route to the local gateway.
UnsupportedOperation.RecordNotExists The record does not exist.
UnsupportedOperation.SystemRoute System route. Operation is prohibited.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy