1. 接口描述
接口请求域名: bmvpc.tencentcloudapi.com 。
本接口(ModifyVpnConnectionAttribute)用于修改VPN通道。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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)。定位问题时需要提供该次请求的 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 平台
腾讯云 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
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网段内。 |