edit-icon download-icon

CreateSslVpnServer

Last Updated: Apr 13, 2018

Description

Create an SSL-VPN server.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: CreateSslVpnServer

RegionId String Yes

The region of the VPN gateway.

You can obtain the region ID by calling the DescribeRegions API.

VpnGatewayId String Yes The ID of the VPN gateway.
LocalSubnet String Yes

The CIDR block to be accessed by the client through the SSL-VPN connection. The local CIDR block can be:

  • The CIDR block of the VPC.

  • The CIDR block of the VSwitch.

  • The CIDR block of the local data center connected to the VPC through a physical connection.
  • The CIDR block of the cloud service such as RDS and OSS.

ClientIpPool String Yes

The CIDR block from which access addresses are allocated to the virtual network interface card of the client. It is not the CIDR block of the client.

When the client accesses the local end through an SSL-VPN connection, the VPN gateway allocates an IP address in the specified CIDR block to the client.

The CIDR block cannot conflict with the LocalSubnet.

Proto String No

The protocol used by the SSL-VPN server.

Valid value: UDP(default) |TCP

Port Integer No

The port used by the SSL-VPN 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].

Cipher String No

The encryption algorithm used by the SSL-VPN server.

Valid value: AES-128-CBC (default)| AES-192-CBC | AES-256-CBC | none

Compress Boolean No

Specify whether to compress the communication.

Valid value: true (default) | false

Name String No

The name of the SSL-VPN server.

  • The name must start with an English letter, but cannot start withhttp:// or https://.

  • The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens.

Response parameters

Name Type Description
RequestId String The ID of the request.
SslVpnServerId String The ID of the SSL-VPN server.
Name String The name of the SSL-VPN server.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=CreateSslVpnServer
  2. &RegionID=cn-beijing
  3. &VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
  4. &LocalSubnet=10.10.10.0/24
  5. &ClientIpPool=10.20.20.0/24
  6. &Name=test
  7. &<CommonParameters>

Response example

XMLformat

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <CreateSslVpnServerResponse>
  3. <RequestId>E98A9651-7098-40C7-8F85-C818D1EBBA85</RequestId>
  4. <SslVpnServerId>vss-bp18q7hzj6largv4vk2fe</SslVpnServerId>
  5. <Name>test</Name>
  6. </CreateSslVpnServerResponse>

JSONformat

  1. {
  2. "RequestId": "E98A9651-7098-40C7-8F85-C818D1EBBA85",
  3. "SslVpnServerId": "vss-bp18q7hzj6largv4vk2fe",
  4. "Name": "test"
  5. }
Thank you! We've received your feedback.