1. 接口描述
接口请求域名： vpc.tencentcloudapi.com 。
本接口用于修改 SSL-VPN 服务端属性
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyVpnGatewaySslServer。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SslVpnServerId | 是 | String | SSL-VPN SERVER 实例ID 示例值：vpns-43eqlqex |
| SslVpnServerName | 否 | String | SSL-VPN SERVER NAME 示例值：rename-test |
| LocalAddress.N | 否 | Array of String | 本端地址 示例值：['10.0.0.0/24'] |
| RemoteAddress | 否 | String | 客户端地址 示例值：9.0.0.0/24 |
| SslVpnProtocol | 否 | String | SSL VPN服务端监听协议。当前仅支持 UDP。默认UDP 示例值：UDP |
| SslVpnPort | 否 | Integer | SSL VPN服务端监听协议端口。 示例值：1194 |
| EncryptAlgorithm | 否 | String | 加密算法。可选 'AES-128-CBC', 'AES-192-CBC', 'AES-256-CBC', 'NONE'。默认NONE 示例值：AES-128 |
| IntegrityAlgorithm | 否 | String | 认证算法。可选 'SHA1', 'MD5', 'NONE'。默认NONE 示例值：HMAC-SHA1 |
| Compress | 否 | Boolean | 是否支持压缩。当前不支持压缩。默认False。 示例值：False |
| SsoEnabled | 否 | Boolean | 是否开启SSO认证。默认为False。该功能当前需要申请开白使用。 示例值：False |
| SamlData | 否 | String | SAML-DATA |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | Integer | 异步任务TASKID 示例值：123 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改SSL-VPN SERVER 属性
修改SSL-VPN SERVER 属性
输入示例
https://vpc.tencentcloudapi.com/?Action=ModifyVpnGatewaySslServer
&SslVpnServerId=vpngwSslServer-8es2sd1u
&SslVpnServerName=update-name
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "ae5ba776-25df-4ca0-814d-15048b40f830",
"TaskId": 0
}
}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.CidrNotInSslVpnVpc | 指定CIDR不在SSL-VPN所属私有网络CIDR内。 |
| InvalidParameterValue.VpcCidrConflict | 目的网段和当前VPC的CIDR冲突。 |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
