私有网络修改VPN路由状态-VPN网关相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： vpc.tencentcloudapi.com 。

本接口（ModifyVpnGatewayRoutes）用于修改VPN路由是否启用。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyVpnGatewayRoutes。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	是	String	公共参数，详见产品支持的地域列表。
VpnGatewayId	是	String	VPN网关实例ID。示例值：vpn-ngenl4az
Routes.N	是	Array of VpnGatewayRouteModify	路由修改参数。示例值：{ 'RouteId': 'vpnr-xxxxxxxx', 'Status': 'ENABLE' }

3. 输出参数

参数名称	类型	描述
Routes	Array of VpnGatewayRoute	VPN路由信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 禁用VPN网关路由

禁用某条VPN网关路由

输入示例

https://vpc.tencentcloudapi.com/?Action=ModifyVpnGatewayRoutes
&VpnGatewayId=vpngw-ngenl4az
&Routes.0.RouteId=vpnr-7t3tknmg
&Routes.0.Status=DISABLE
&<公共请求参数>

输出示例

{
    "Response": {
        "Routes": [
            {
                "RouteId": "vpnr-7t3tknmg",
                "DestinationCidrBlock": "10.11.0.0/16",
                "Status": "DISABLE",
                "InstanceId": "vpnx-ng2asdew",
                "InstanceType": "VPNCONN",
                "Priority": 0,
                "Type": "Static",
                "CreateTime": "2023-03-21 07:08:13",
                "UpdateTime": "2023-04-28 17:02:43"
            }
        ],
        "RequestId": "6e446c86-d8c9-4981-9b33-d10956585058"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。
UnsupportedOperation.RecordNotExists	记录不存在。

修改VPN路由状态

本页目录：