修改VPN通道

最近更新时间:2019-07-24 15:03:07

1. 接口描述

接口请求域名: bmvpc.tencentcloudapi.com 。

本接口(ModifyVpnConnectionAttribute)用于修改VPN通道。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyVpnConnectionAttribute
Version String 公共参数,本接口取值:2018-06-25
Region String 公共参数,本接口不需要传递此参数。
VpnConnectionId String VPN通道实例ID。形如:bmvpnx-f49l6u0z。
VpcId String VPC实例ID
VpnConnectionName String VPN通道名称,可任意命名,但不得超过60个字符。
PreShareKey String 预共享密钥。
SecurityPolicyDatabases.N Array of SecurityPolicyDatabase SPD策略组,例如:{"10.0.0.5/24":["172.123.10.5/16"]},10.0.0.5/24是vpc内网段172.123.10.5/16是IDC网段。用户指定VPC内哪些网段可以和您IDC中哪些网段通信。
IKEOptionsSpecification IKEOptionsSpecification IKE配置(Internet Key Exchange,因特网密钥交换),IKE具有一套自我保护机制,用户配置网络安全协议。
IPSECOptionsSpecification IPSECOptionsSpecification IPSec配置,腾讯云提供IPSec安全会话设置。

3. 输出参数

参数名称 类型 描述
TaskId Integer 任务ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改VPN通道

输入示例

https://bmvpc.tencentcloudapi.com/?Action=ModifyVpnConnectionAttribute
&Version=2018-06-25
&VpnConnectionId=bmvpnx-qc8cz8y8
&VpnConnectionName=TEST_CONN
&VpcId=vpc-q8cz9732
&<公共请求参数>

输出示例

{
  "Response": {
    "TaskId": 1234,
    "RequestId": "09186e64-d19e-4ca1-968f-df4fc8139192"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误
LimitExceeded 超过配额限制
LimitExceeded.SpdAclLimit 可创建的VPN通道SPD ACL数达到上限。
LimitExceeded.SpdDnetLimit 可创建的VPN通道SPD ACL目的地址数达到上限。
LimitExceeded.SpdSnetLimit 可创建的VPN通道SPD ACL源地址数达到上限。
ResourceNotFound.NotAvaible 联通状态的通道才可以重置。
ResourceNotFound.VpcNotExist VPC不存在。
ResourceNotFound.VpnConnNotExist VPN通道不存在。
UnsupportedOperation.InvalidVpnConnState VPN通道状态不正确。
UnsupportedOperation.SpdAclCidrInvalid SPD策略源目的地址冲突。
UnsupportedOperation.SpdSnetNotInCidr SPD策略源地址不在VPC网段内。