Modifies the configurations of an SSL-VPN server.

Debug

By using API Explorer, you can easily debug APIs, automatically generate SDK code examples, and quickly search for APIs.

Request parameters

Parameter Type Required? Example value Description
Action String Yes ModifySslVpnServer

The name of this action. Value:

ModifySslVpnServer

RegionId String Yes cn-hangzhou

The ID of the region to which the VPN Gateway belongs.

To query the region ID, call DescribeRegions.

SslVpnServerId String Yes vss-bp18q7hzj6largv4vk2fe

The ID of the SSL-VPN server.

Cipher String No AES-128-CBC

The encryption algorithm used by the SSL-VPN server. Valid values:

AES-128-CBC (default) | AES-192-CBC | AES-256-CBC | none

ClientIpPool String Yes 10.30.30.0/2

The CIDR block from which IP 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.

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

A client token used to guarantee the idempotence of requests.

This parameter value is generated by the client and must be unique. It must be 1 to 64 ASCII characters in length.

Compress Boolean  No false

Indicates whether to enable compression.

Valid values: true (default) | false

LocalSubnet String No 10.20.20.0/24

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 on-premises data center connected to the VPC through a physical connection, or the CIDR block of an Alibaba Cloud service, such as RDS or OSS.

Name String No test

The name of the SSL-VPN server.

The name must be 2 to 128 characters in length and can contain letters, numbers, periods (.), underscores (_), and hyphens (-). The name must start with a letter. It cannot start with http:// or https://.

Port Integer No 1194

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

Proto String No UDP

The protocol used by the SSL-VPN server.

Response parameters

Parameter Type Example value Description
Cipher String AES-128-CBC

The encryption algorithm used.

ClientIpPool String 10.30.30.0/24

The IP address pool of the client.

Compress Boolean false

Whether to compress the communication.

Connections Integer 0

The number of current connections.

CreateTime Long 1492753580000

The time at which the SSL-VPN server was created.

InternetIp String 47.98.xx.xx

The public IP address.

LocalSubnet String 10.20.20.0/24

The CIDR block of the local client.

MaxConnections Integer 5

The maximum number of concurrent connections.

Name String test

The name of the SSL-VPN server.

Port Integer 1194

The port of the SSL-VPN server.

Proto String UDP

The protocol used by the SSL-VPN server.

RegionId String cn-hangzhou

The ID of the region to which the SSL-VPN server belongs.

RequestId String DF11D6F6-E35A-41C3-9B20-6FC8A901FE65

The ID of the request.

SslVpnServerId String vss-bp18q7hzj6largv4vk2fe

The ID of the SSL-VPN server.

VpnGatewayId String vpn-bp1q8bgx4xnkm2ogj0fiu

The ID of the VPN Gateway.

Examples

Request example


https://vpc.aliyuncs.com/?Action=ModifySslVpnServer
&RegionId=cn-hangzhou
&SslVpnServerId=vss-bp18q7hzj6largv4vk2fe
&<CommonParameters>
Response example
  • XML format

    <ModifySslVpnServerResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <SslVpnServers>
        <SslVpnServer>
          <RegionId>cn-hanghzou</RegionId>
          <SslVpnServerId>vss-bp18q7hzj6largv4vk2fe</SslVpnServerId>
          <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
          <Name>test</Name>
          <CLientIpPool>10.30.30.0/24</CLientIpPool>
          <LocalSubnet>10.20.20.0/24</LocalSubnet>
          <Proto>UDP</Proto>
          <Port>1194</Port>
          <Cipher>AES-128-CBC</Cipher>
          <Compress>true</Compress>
          <CreateTime>1492753580000</CreateTime>
          <Connections>0</Connections>
          <MaxConnections>5</MaxConnections>
          <InternetIp>47.98.xx.xx</InternetIp>
        </SslVpnServer>
      </SslVpnServers>
      <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    </ModifySslVpnServerResponse>
    
  • JSON format

    {
    	"PageNumber":"1",
    	"TotalCount":"1",
    	"SslVpnServers":{
    		"SslVpnServer":{
    			"VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj0fiu",
    			"CLientIpPool":"10.30.30.0/24",
    			"Proto":"UDP",
    			"Cipher":"AES-128-CBC",
    			"InternetIp":"47.98.xx.xx",
    			"SslVpnServerId":"vss-bp18q7hzj6largv4vk2fe",
    			"Name":"test",
    			"Port":"1194",
    			"MaxConnections":"5",
    			"RegionId":"cn-hanghzou",
    			"CreateTime":"1492753580000",
    			"Compress":"true",
    			"LocalSubnet":"10.20.20.0/24",
    			"Connections":"0"
    		}
    	},
    	"PageSize":"10",
    	"RequestId":"DF11D6F6-E35A-41C3-9B20-6FC8A901FE65"
    }

Error codes

HTTP status code Error code Error message Description
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. You are not authorized to operate on this resource. Please apply for the permission and try again.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource. Please open a ticket.
400 InvalidName The name is not valid The name format is invalid.
400 VpnGateway.Configuring The specified service is configuring. The service is being configured. Please try again later.
400 VpnGateway.FinancialLocked The specified service is financial locked. The service is stopped due to insufficient account balance. Please renew your account first.

See common error codes