Help & DocumentationVirtual Private CloudAPI DocumentationRoute Table-Related APIsCreateRoutes

CreateRoutes

Last updated: 2020-03-06 20:26:39

PDF

Contents：

1. API Description

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

This API (CreateRoutes) is used to create a routing policy.

  • You can create routing policies in batch for a specified route table.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateRoutes.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a routing policy

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateRoutes
&Version=2017-03-12
&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": {
    "RouteTableSet": [
      {
        "VpcId": "vpc-k23blx7p",
        "RouteTableId": "rtb-n0yejvje",
        "RouteTableName": "TestRoutes",
        "AssociationSet": [],
        "RouteSet": [
          {
            "RouteId": 12345678
          }
        ],
        "Main": false
      }
    ],
    "TotalCount": 1,
    "RequestId": "3f934a21-2786-44af-a421-38ee6c6e1fae"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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 Invalid 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.VpcCidrConflict Destination IP address range conflicts with CIDR of the current VPC.
LimitExceeded Quota limit is reached.
UnsupportedOperation Unsupported operation.
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.SystemRoute System route. Operation is prohibited.