tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateRoutes

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

    1. API Description

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

    This API is used to create routes.

    • You can batch add routes to a specified 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: CreateRoutes.
    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 Yes Array of Route Routing policy object.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer The number of newly added 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 Creating a route

    This example shows you how to create routes.

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=CreateRoutes
&RouteTableId=rtb-n0yejvje
&Routes.0.DestinationCidrBlock=192.168.0.0/16
&Routes.0.GatewayType=NORMAL_CVM
&Routes.0.GatewayId=172.16.16.37
&Routes.0.RouteDescription=TEST-CVM-ROUTE
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "RouteTableSet": [
            {
                "RouteSet": [
                    {
                        "CreatedTime": "2020-09-22 00:00:00",
                        "DestinationCidrBlock": "192.168.0.0/16",
                        "RouteTableId": "rtb-n0yejvje",
                        "RouteItemId": "rti-psm73tvu",
                        "RouteDescription": "erty",
                        "Enabled": true,
                        "RouteId": 1,
                        "GatewayType": "NORMAL_CVM",
                        "GatewayId": "172.16.16.37"
                    }
                ],
                "RouteTableId": "rtb-n0yejvje",
                "VpcId": "vpc-4cugx77a",
                "RouteTableName": "TEST",
                "TagSet": [
                    {
                        "Value": "test",
                        "Key": "ee"
                    }
                ],
                "CreatedTime": "2020-09-22 00:00:00",
                "AssociationSet": [
                    {
                        "SubnetId": "subnet-1234derf",
                        "RouteTableId": "rtb-n0yejvje"
                    }
                ],
                "Main": false,
                "LocalCidrForCcn": [
                    {
                        "Cidr": "10.0.0.0/16",
                        "PublishedToVbc": true
                    }
                ]
            }
        ],
        "RequestId": "a949ecd8-a223-4b96-8537-a8a68a5ba47a"
    }
}

    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 The parameter value is invalid.
    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.RoutePolicyPriorityConflict
    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.EcmpWithCcnRoute Form an ECMP with the CCN route.
    UnsupportedOperation.EcmpWithUserRoute Form an ECMP with the user’s custom routes.
    UnsupportedOperation.NormalSubnetNotSupportLocalGateway The specified subnet does not support creating a route to the local gateway.
    UnsupportedOperation.SystemRoute System route. Operation is prohibited.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy