CreateSslVpnServer - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	CreateSslVpnServer	The operation that you want to perform. Set the value to CreateSslVpnServer.
ClientToken	String	No	02fb3da4-130e-11e9-8e44-0016e04115b	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
RegionId	String	Yes	cn-shanghai	The ID of the region where the VPN gateway is created. You can call the DescribeRegions operation to query the most recent region list.
VpnGatewayId	String	Yes	vpn-bp1hgim8by0kc9nga****	The ID of the VPN gateway.
Name	String	No	sslvpnname	The name of the SSL server. The name must be 2 to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter but cannot start with `http://` or `https://`.
ClientIpPool	String	Yes	192.168.1.0/24	The client CIDR block. The CIDR block that is allocated to the virtual network interface of the client. It is not the CIDR block where the client resides. When the client accesses the destination network through an SSL-VPN connection, the VPN gateway allocates an IP address from the client CIDR block to the client. Note This CIDR block cannot conflict with the CIDR block specified by LocalSubnet.
LocalSubnet	String	Yes	10.0.0.0/8	The local CIDR block. The CIDR block to be accessed by the client through the SSL-VPN connection. This value can be the CIDR block of a virtual private cloud (VPC), a vSwitch, a data center that is connected to a VPC through an Express Connect circuit, or Object Storage Service (OSS).
Proto	String	No	UDP	The protocol that is used by the SSL server. Valid values: TCP: TCP UDP (default): UDP
Cipher	String	No	AES-128-CBC	The encryption algorithm that is used in the SSL-VPN connection. Valid values: AES-128-CBC (default): AES-128-CBC AES-192-CBC: AES-192-CBC AES-256-CBC: AES-256-CBC none: does not use an encryption algorithm.
Port	Integer	No	1194	The port used by the SSL server. Default value: 1194. The following ports cannot be used: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, and 4500.
Compress	Boolean	No	false	Specifies whether to enable data compression. Valid values: true: yes false (default): no
EnableMultiFactorAuth	Boolean	No	false	Specifies whether to enable two-factor authentication. Valid values: true: yes false (default): no Note To enable two-factor authentication, make sure that the VPN gateway was created after 00:00:00 (UTC+8), March 5, 2020. Otherwise, two-factor authentication is not supported.
IDaaSInstanceId	String	No	idaas-cn-hangzhou-p****	The ID of the Identity as a Service (IDaaS) instance.
IDaaSRegionId	String	No	cn-hangzhou	The ID of the region where the IDaaS instance is created.

Response parameters


Parameter	Type	Example	Description
SslVpnServerId	String	vss-bp18q7hzj6largv4v****	The ID of the SSL server.
RequestId	String	E98A9651-7098-40C7-8F85-C818D1EBBA85	The ID of the request.
Name	String	test	The name of the SSL server.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateSslVpnServer
&ClientIpPool=192.168.1.0/24
&LocalSubnet=10.0.0.0/8
&RegionId=cn-shanghai
&VpnGatewayId=vpn-bp1hgim8by0kc9nga****
&<Common request parameters>

Sample success responses

XML format

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 format

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

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

Error codes


HttpCode	Error code	Error message	Description
400	Resource.QuotaFull	The quota of resource is full	The error message returned because the resource quota is reached.
400	InvalidName	The name is not valid	The error message returned because the format of the name is invalid.
400	VpnGateway.Configuring	The specified service is configuring.	The error message returned because the specified service is being configured. Try again later.
400	VpnGateway.FinancialLocked	The specified service is financial locked.	The error message returned because the service is suspended due to overdue payments. Top up your account before you enable the service.
400	QuotaExceeded.VpnRouteEntry	The number of route entries to the VPN gateway in the VPC routing table has reached the quota limit.	The error message returned because the number of routes that point to the VPN gateway in the VPC route table reaches the upper limit.
400	SystemBusy	The system is busy. Please try again later.	The error message returned because the system is busy. Try again later.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again.
403	Forbidden	User not authorized to operate on the specified resource.	The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again.
404	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.

For a list of error codes, visit the API Error Center.