调用CreateSslVpnServer接口创建SSL-VPN服务端。

使用说明

  • CreateSslVpnServer接口属于异步接口,即系统先返回一个实例ID,但该SSL-VPN服务端尚未创建成功,系统后台的创建任务仍在进行。您可以调用DescribeVpnGateway查询VPN网关实例的状态,来确定SSL-VPN服务端的创建状态:
    • 当VPN网关实例处于updating状态时,表示SSL-VPN服务端正在创建中。
    • 当VPN网关实例处于active状态时,表示SSL-VPN服务端创建成功。
  • CreateSslVpnServer接口不支持在同一VPN网关下并发创建SSL-VPN服务端。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateSslVpnServer

系统规定参数。取值:CreateSslVpnServer

ClientToken String 02fb3da4-130e-11e9-8e44-0016e04115b

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
RegionId String cn-shanghai

VPN网关所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

VpnGatewayId String vpn-bp1hgim8by0kc9nga****

VPN网关的ID。

Name String sslvpnname

SSL-VPN服务端的名称。

长度为1~100个字符,不能以http://https://开头。

ClientIpPool String 192.168.1.0/24

客户端网段。

是给客户端虚拟网卡分配访问地址的地址段,不是指客户端已有的内网网段。

当客户端通过SSL-VPN连接访问本端时,VPN网关会从指定的客户端网段中分配一个IP地址给客户端使用。

说明 该网段不能与LocalSubnet地址段冲突。
LocalSubnet String 10.0.0.0/8

本端网段。

是客户端通过SSL-VPN连接要访问的地址段。

本端网段可以是VPC的网段、交换机的网段、通过专线和VPC互连的IDC的网段、云服务如对象存储服务OSS(Object Storage Service)等的网段。

Proto String UDP

SSL-VPN服务端所使用的协议,取值:

  • TCP:TCP协议。
  • UDP(默认值):UDP协议。
Cipher String AES-128-CBC

SSL-VPN使用的加密算法,取值:

  • AES-128-CBC(默认值):AES-128-CBC算法。
  • AES-192-CBC:AES-192-CBC算法。
  • AES-256-CBC:AES-256-CBC算法。
  • none:不使用加密算法。
Port Integer 1194

SSL-VPN服务端所使用的端口,默认值为1194。 不能用使用以下端口:

22、2222、22222、9000、9001、9002、7505、80、443、53、68、123、4510、4560、500、4500

Compress Boolean false

指定是否对通信进行压缩, 取值:

  • true:对通信进行压缩。
  • false(默认值):对通信不进行压缩。
EnableMultiFactorAuth Boolean false

是否开启双因子认证。取值:

  • true:开启。
  • false(默认值):不开启。
说明 如果您要使用双因子认证功能,请确保您的VPN网关是在2020年03月05日00时00分之后创建的,否则您的VPN网关将不支持双因子认证功能。
IDaaSInstanceId String idaas-cn-hangzhou-p****

IDaaS实例ID。

IDaaSRegionId String cn-hangzhou

IDaaS实例所属地域ID。

返回数据

名称 类型 示例值 描述
SslVpnServerId String vss-bp18q7hzj6largv4v****

SSL-VPN服务端的ID。

RequestId String E98A9651-7098-40C7-8F85-C818D1EBBA85

请求ID。

Name String test

SSL-VPN服务端的名称。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSslVpnServer
&ClientIpPool=192.168.1.0/24
&LocalSubnet=10.0.0.0/8
&RegionId=cn-shanghai
&VpnGatewayId=vpn-bp1hgim8by0kc9nga****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSslVpnServerResponse>
    <RequestId>E98A9651-7098-40C7-8F85-C818D1EBBA85</RequestId>
    <SslVpnServerId>vss-bp18q7hzj6largv4v****</SslVpnServerId>
    <Name>test</Name>
</CreateSslVpnServerResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "E98A9651-7098-40C7-8F85-C818D1EBBA85",
  "SslVpnServerId" : "vss-bp18q7hzj6largv4v****",
  "Name" : "test"
}

错误码

HttpCode 错误码 错误信息 描述
400 Resource.QuotaFull The quota of resource is full 资源配额已达上限。
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 VpnRouteEntry.Conflict The specified route entry has conflict. 路由条目存在冲突。
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.NoRamPermission Vpn Service has no permission to operate your IDaaS instances. Vpn服务没有权限操作您的IDaaS实例
400 QuotaExceeded.VpnRouteEntry The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit. VPC路由表中指向VPN网关的路由条目已经达到配额限制。
400 SystemBusy The system is busy. Please try again later. 当前系统繁忙,请稍后重试。
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 InvalidVpnGatewayInstanceId.NotFound The specified vpn gateway instance id does not exist. 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。

访问错误中心查看更多错误码。