1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口（ModifyVpnConnectionAttribute）用于修改VPN通道。
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyVpnConnectionAttribute。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| VpnConnectionId | 是 | String | VPN通道实例ID。形如：vpnx-f49l6u0z。 示例值：vpnx-i0f4fo4m |
| VpnConnectionName | 否 | String | VPN通道名称，可任意命名，但不得超过60个字符。 示例值：new_name |
| PreShareKey | 否 | String | 预共享密钥。 示例值：tencent |
| 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安全会话设置。 |
| EnableHealthCheck | 否 | Boolean | 是否启用通道健康检查，默认为False。 |
| HealthCheckLocalIp | 否 | String | 本端通道探测IP。 |
| HealthCheckRemoteIp | 否 | String | 对端通道探测IP。 |
| NegotiationType | 否 | String | 协商类型，默认为active（主动协商）。可选值：active（主动协商），passive（被动协商），flowTrigger（流量协商） 示例值：active |
| DpdEnable | 否 | Integer | DPD探测开关。默认为0，表示关闭DPD探测。可选值：0（关闭），1（开启） 示例值：1 |
| DpdTimeout | 否 | String | DPD超时时间。即探测确认对端不存在需要的时间。dpdEnable为1（开启）时有效。默认30，单位为秒 示例值：30 |
| DpdAction | 否 | String | DPD超时后的动作。默认为clear。dpdEnable为1（开启）时有效。可取值为clear（断开）和restart（重试） 示例值：clear |
| CustomerGatewayId | 否 | String | 对端网关ID，4.0及以上网关下的通道支持更新。 示例值：cgw-b6nlimbr |
| HealthCheckConfig | 否 | HealthCheckConfig | 健康检查配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改VPN通道
修改VPN通道
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyVpnConnectionAttribute
<公共请求参数>
{
"VpnConnectionName": "test-abc",
"VpnConnectionId": "vpnx-abc123x",
"PreShareKey": "123",
"EnableHealthCheck": "false"
}输出示例
{
"Response": {
"RequestId": "b6c8a8c4-ba39-49ca-9b21-66247b7e3ad3"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
| InvalidParameterValue.Malformed | 入参格式不合法。 |
| InvalidParameterValue.VpnConnCidrConflict | 目的网段和当前VPN通道的CIDR冲突。 |
| InvalidParameterValue.VpnConnHealthCheckIpConflict | VPN通道探测ip冲突。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation.InvalidState | 资源状态不合法。 |
| UnsupportedOperation.VpnConnInvalidState | 当前通道为非可用状态，不支持该操作。 |
| UnsupportedOperation.VpnConnSPDOverlap | SPD本端网段冲突，请检查后重试。 |
