CreateSslVpnServer
Description
call CreateSslVpnServer interface to create SSL-VPN server.
Request Method
POST
Request Path
/apsara/route/Vpc/CreateSslVpnServer
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
LocalSubnet | BODY | string | Yes | 10.0.0.0/8 | is the address segment to be accessed by the client through the SSL-VPN connection. the local network segment can be the network segment of VPC, the network segment of switch, the network segment of IDC interconnected through dedicated line and VPC, and the network segment of cloud services such as RDS/OSS. |
Compress | BODY | boolean | No | false | specifies whether to compress the communication, value: true: Compress the communication. false(default): communications are not compressed. |
ClientIpPool | BODY | string | Yes | 192.168.1.0/24 | is the address segment that assigns the access address to the client virtual network card, not the existing internal network segment of the client. /p> p data-tag = "p" class = "p"> when the client accesses the local terminal through the SSL-VPN connection, the VPN gateway will assign an IP address from the specified client network segment to the client for use. this network segment cannot conflict with LocalSubnet address segment. |
Port | BODY | integer | No | 1194 | SSL-VPN the port used by the server, the default value is 1194. The following ports cannot be used: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, 4500. |
version | BODY | string | No | 2016-01-01 | version of api |
Name | BODY | string | No | sslvpnname | SSL-VPN the name of the server. is 2 to 128 characters in length, must start with a letter or Chinese, and can contain numbers, half-width periods (.), underscores (_), and dashes (-). But you cannot use http:// or https:// start. |
Proto | BODY | string | No | UDP | SSL-VPN the protocol used by the server, value: TCP:TCP protocol. UDP(default):UDP protocol. |
VpnGatewayId | BODY | string | Yes | vpn-bp1hgim8by0kc9nga**** | VPN gateway ID. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
RegionId | BODY | string | Yes | cn-qingdao-env66-d01 | the region ID where the VPN gateway is located. you can obtain the region by calling DescribeRegions interface ID. |
Cipher | BODY | string | No | AES-128-CBC | SSL-VPN used encryption algorithm, value: AES-128-CBC(default):AES-128-CBC algorithm. AES-192-CBC:AES-192-CBC algorithm. AES-256-CBC:AES-256-CBC algorithm. none: no encryption algorithm is used. |
ClientToken | BODY | string | No | 02fb3da4-130e-11e9-8e44-0016e04115b | client token, used to ensure the idempotence of the request. The parameter value is generated by the client. It must be unique between different requests, and the maximum value is not more than 64 ASCII characters. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}