tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVpnGatewayRoutes

Last updated: 2024-11-25 20:07:03

    1. API Description

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

    This API is used to create destination routes of a route-based VPN gateway.

    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: CreateVpnGatewayRoutes.
    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.
    VpnGatewayId Yes String VPN gateway ID
    Routes.N Yes Array of VpnGatewayRoute Destination route list of a VPN gateway

    3. Output Parameters

    Parameter Name Type Description
    Routes Array of VpnGatewayRoute Destination routes of a VPN gateway
    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 destination routes of a VPN gateway

    This example shows you how to create destination routes of a route-based VPN gateway.

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=CreateVpnGatewayRoutes
&VpnGatewayId=vpn-ngenl4az
&Routes.0.DestinationCidrBlock=192.241.0.0/24
&Routes.0.Status=ENABLE
&Routes.0.InstanceType=VPNCONN
&Routes.0.InstanceId=vpnx-ng2asdew
&Routes.0.Priority=100
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Routes": [
            {
                "DestinationCidrBlock": "192.241.0.0/24",
                "Status": "ENABLE",
                "InstanceId": "vpnx-ng2asdew",
                "InstanceType": "VPNCONN",
                "Priority": 100
            }
        ],
        "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058"
    }
}

    Example2 Creating destination routes of a route-based VPN gateway

    This example shows you how to create destination routes of a route-based VPN gateway.

    Input Example

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

{
    "Routes": [
        {
            "Status": "ENABLE",
            "Priority": "0",
            "InstanceId": "vpnx-f99clft2",
            "InstanceType": "VPNCONN",
            "DestinationCidrBlock": "172.0.0.0/16"
        }
    ],
    "VpnGatewayId": "vpngw-7lhl5331"
}

    Output Example

    {
    "Response": {
        "Routes": [
            {
                "RouteId": "vpnr-85lq3m31",
                "DestinationCidrBlock": "172.0.0.0/16",
                "Status": "ENABLE",
                "InstanceId": "vpnx-f99clft2",
                "InstanceType": "VPNCONN",
                "Priority": 0,
                "Type": "Static",
                "CreateTime": "0000-00-00 00:00:00",
                "UpdateTime": "0000-00-00 00:00:00"
            }
        ],
        "RequestId": "a713021b-1942-4569-aa08-d8ad1867c2ad"
    }
}

    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
    InternalError An internal error occurred.
    InvalidParameter A parameter error occurred.
    InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
    InvalidParameterValue.Malformed Invalid input parameter format.
    LimitExceeded Quota limit is reached.
    MissingParameter Missing parameter.
    ResourceNotFound The resource does not exist.
    UnknownParameter Unknown parameter error.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy