Last updated: 2021-07-06 16:37:56

1. API Description

Domain name for API request:

This API is used to modify the route status of a VPN gateway.

A maximum of 20 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:

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 parameter. The value used for this API: ModifyVpnGatewayRoutes.
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.
VpnGatewayId Yes String VPN gateway ID
Routes.N Yes Array of VpnGatewayRouteModify Route parameters to modify

3. Output Parameters

Parameter Name Type Description
Routes Array of VpnGatewayRoute Route information of the VPN gateway
Note: this field may return null, indicating that no valid value is obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Disabling a route of a VPN gateway

This example shows you how to disable a route of a VPN gateway.

Input Example
&<Common request parameters>

Output Example

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

5. Developer Resources


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.
ResourceNotFound The resource does not exist.
ResourceUnavailable The resource is unavailable.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.