调用ModifySslVpnServer接口修改SSL-VPN服务端的配置信息。
接口说明
-
如果您需要为 SSL 服务端开启双因子认证功能，请先确保 VPN 网关实例支持该功能，您可能需要升级 VPN 网关实例。更多信息，请参见SSL-VPN 双因子认证支持 IDaaS EIAM 2.0。
-
当只修改 SSL-VPN 服务端 Name 信息时该接口为同步接口，如果还修改了除 Name 之外的配置，该接口为异步接口。
-
ModifySslVpnServer 接口为异步接口时，即系统先返回一个请求 ID，但该 SSL-VPN 服务端的配置信息尚未修改成功，系统后台的修改任务仍在进行。您可以调用 DescribeVpnGateway 接口查询 SSL-VPN 服务端关联的 VPN 网关实例的状态，来确认 SSL-VPN 服务端配置信息的修改状态：
- 当 VPN 网关实例处于 updating 状态时，表示 SSL-VPN 服务端的配置信息正在修改中。
- 当 VPN 网关实例处于 active 状态时，表示 SSL-VPN 服务端的配置信息修改成功。
-
ModifySslVpnServer 接口不支持在同一 VPN 网关下并发修改 SSL-VPN 服务端的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:ModifySslVpnServer | update | *SslVpnServer acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客户端 Token，用于保证请求的幂等性。 从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 02fb3da4-130e-11e9-8e44-0016e04115b |
| RegionId | string | 是 | VPN 网关所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
| SslVpnServerId | string | 是 | SSL-VPN 服务端实例 ID。 | vss-bp18q7hzj6largv4v**** |
| Name | string | 否 | SSL-VPN 服务端的名称。 长度为 1～100 个字符，不能以 | test |
| ClientIpPool | string | 否 | 客户端 IP 地址池。 | 10.30.30.0/24 |
| LocalSubnet | string | 否 | 本地客户端的网段。 | 10.20.20.0/24 |
| Proto | string | 否 | SSL-VPN 服务端所使用的协议，取值：
| UDP |
| Cipher | string | 否 | SSL-VPN 使用的加密算法，取值：
| AES-128-CBC |
| Port | integer | 否 | SSL-VPN 服务端所使用的端口。端口取值范围：1~65535。默认值：1194。 不支持使用以下端口：22、2222、22222、9000、9001、9002、7505、80、443、53、68、123、4510、4560、500、4500。 | 1194 |
| Compress | boolean | 否 | 指定是否对通信进行压缩， 取值：
| true |
| EnableMultiFactorAuth | boolean | 否 | 是否开启双因子认证。如果您选择开启双因子认证功能，您还需要输入 IDaaS EIAM 实例 ID 和 IDaaS 应用 ID。取值：
说明
| false |
| IDaaSInstanceId | string | 否 | IDaaS EIAM 实例 ID。 | idaas-cn-hangzhou-**** |
| IDaaSRegionId | string | 否 | IDaaS EIAM 实例所属地域 ID。 | cn-hangzhou |
| IDaaSApplicationId | string | 否 | IDaaS 应用 ID。
| app_my6g4qmvnwxzj2f**** |
返回参数
示例
正常返回示例
JSON格式
{
"InternetIp": "47.98.XX.XX",
"IDaaSInstanceId": "idaas-cn-hangzhou-****",
"CreateTime": 1492753580000,
"VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
"Compress": false,
"Port": 1194,
"LocalSubnet": "10.20.20.0/24",
"RegionId": "cn-hangzhou",
"Cipher": "AES-128-CBC",
"RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
"Connections": 0,
"SslVpnServerId": "vss-bp18q7hzj6largv4v****",
"MaxConnections": 5,
"Name": "test",
"EnableMultiFactorAuth": false,
"ClientIpPool": "10.30.30.0/24",
"Proto": "UDP",
"ResourceGroupId": "rg-acfmzs372yg****",
"IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
"IDaaSInstanceVersion": "EIAM 2.0"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidName | The name is not valid | 该名称格式不合法。 |
| 400 | VpnGateway.Configuring | The specified service is configuring. | 服务正在配置中，请您稍后再试。 |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | 该服务已欠费，请您先充值再操作。 |
| 400 | IpConflict | Client IP pool conflict with local IP range. | 客户端IP池与本地IP范围冲突。 |
| 400 | IpConflict | Client IP pool conflict with other SSL VPN server in the same VPC. | 客户端IP池与同一VPC中的其他SSL VPN服务器冲突。 |
| 400 | SslVpnServer.AddRouteError | Add route error whose destination is client IP pool, please check vpc route entry and relevant quota. | 添加指向客户端网段的路由失败，请查看VPC路由条目及相关配额。 |
| 400 | ClientIpPool.NetmaskInvalid | The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29. | 客户端 IP 池的网络掩码长度必须大于等于 16 且小于等于 29。 |
| 400 | ClientIpPool.SubnetInvalid | The specified client IP pool cannot be used. | 当前客户端网段不可用。 |
| 400 | MissingParameter.IDaaSInstanceId | The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication. | 启动双因子认证时请输入IDaaSInstanceId参数。 |
| 400 | OperationFailed.GetIDaaSInfo | Failed to get secret key from your IDaaS instance. | - |
| 400 | OperationFailed.NoRamPermission | Vpn Service has no permission to operate your IDaaS instances. | Vpn服务没有权限操作您的IDaaS实例 |
| 400 | OperationUnsupported.NotSupportMultiFactorAuth | Current version of the VPN does not support multi-factor authentication. | - |
| 400 | SystemBusy | The system is busy. Please try again later. | 当前系统繁忙，请稍后重试。 |
| 400 | SslVpnServerPort.Illegal | The server port is not in the range of [1-65535]. | SSL VPN 服务端端口号需要在[1-65535]之间。 |
| 400 | EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDest | Ssl vpn client cidr contains vpc route prefix. The vpc route prefix is %s. | vpc路由表中存在路由的前缀%s被包含在ssl vpn 客户端 cidr 中。 |
| 400 | InvalidInstanceId.NotFound | InstanceId is not found. | 物理专线实例ID不存在。 |
| 400 | VpnRouteEntry.Conflict | The specified route entry has conflict. | 路由条目存在冲突。 |
| 400 | IllegalParam.IDaaSApplicationId | The specified IDaaS application Id is not illegal, the application instance needs to be created based on the dedicated SSL VPN template. | 指定的IDaaS应用实例ID不合法，应用实例需要基于专属SSL VPN的模板创建。 |
| 400 | MissingParam.IDaaSApplicationId | The input parameter IDaaSApplicationId is mandatory when enable multi-factor authentication. | 启动双因子认证时请输入IDaaSApplicationId参数。 |
| 400 | SslVpnIDaaS2.NotSupport | Current version of the VPN does not support IDaaS2.0. | 当前VPN实例版本不支持使用IDaaS2.0。 |
| 400 | MissingParam.IDaaSRegionId | The input parameter IDaaSRegionId is mandatory when enable multi-factor authentication. | 启动双因子认证时请输入IDaaSRegionId参数。 |
| 403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您没有权限操作该资源，请您申请操作权限后再试。 |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源，请申请权限后再操作。 |
| 404 | InvalidRegionId.NotFound | The specified region is not found during access authentication. | 接入认证时未找到指定区域。 |
| 404 | InvalidIDaaSInstanceId.NotFound | The specified IDaaS instance ID does not exist. | 指定的IDaaS实例ID不存在 |
| 404 | InvalidIDaaSApplicationId.NotFound | The specified IDaaS application Id does not exist. | 指定的IDaaS应用实例ID不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-01-04 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-30 | OpenAPI 错误码发生变更 | 查看变更详情 |