Modifies the configuration of an SSL server.

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 ModifySslVpnServer

The operation that you want to perform. Set the value to ModifySslVpnServer.

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-hangzhou

The ID of the region where the VPN gateway is created.

You can call the DescribeRegions operation to query the most recent region list.

SslVpnServerId String Yes vss-bp18q7hzj6largv4v****

The ID of the SSL server.

Name String No test

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. The name must start with a letter but cannot start with http:// or https://.

ClientIpPool String No 10.30.30.0/24

The client IP address pool.

LocalSubnet String No 10.20.20.0/24

The CIDR block of the client.

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 true

Specifies whether to enable data compression. Valid values:

  • true (default): yes
  • false: no
EnableMultiFactorAuth Boolean No false

Specifies whether to enable two-factor authentication.

  • true: yes
  • false (default): no
IDaaSInstanceId String No idaas-cn-hangzhou-****

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
InternetIp String 47.98.XX.XX

The public IP address.

IDaaSInstanceId String idaas-cn-hangzhou-****

The ID of the IDaaS instance.

CreateTime Long 1492753580000

The time when the SSL server was created.

VpnGatewayId String vpn-bp1q8bgx4xnkm2ogj****

The ID of the VPN gateway.

Compress Boolean false

Indicates whether data compression is enabled.

Port Integer 1194

The port that is used by the SSL server.

LocalSubnet String 10.20.20.0/24

The CIDR block of the client.

RegionId String cn-hangzhou

The ID of the region where the SSL server is created.

Cipher String AES-128-CBC

The encryption algorithm.

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

The ID of the request.

Connections Integer 0

The total number of current connections.

SslVpnServerId String vss-bp18q7hzj6largv4v****

The ID of the SSL server.

MaxConnections Integer 5

The maximum number of connections.

Name String test

The name of the SSL server.

EnableMultiFactorAuth Boolean false

Indicates whether two-factor authentication is enabled.

  • true: yes
  • false (default): no
ClientIpPool String 10.30.30.0/24

The client IP address pool.

Proto String UDP

The protocol that is used by the SSL server.

Examples

Sample requests

https://vpc.aliyuncs.com/?Action=ModifySslVpnServer
&RegionId=cn-hangzhou
&SslVpnServerId=vss-bp18q7hzj6largv4****
&<Common request parameters>

Sample success responses

XML format

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

<ModifySslVpnServerResponse>
    <InternetIp>47.98.XX.XX</InternetIp>
    <IDaaSInstanceId>idaas-cn-hangzhou-****</IDaaSInstanceId>
    <CreateTime>1492753580000</CreateTime>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <Compress>false</Compress>
    <Port>1194</Port>
    <LocalSubnet>10.20.20.0/24</LocalSubnet>
    <RegionId>cn-hangzhou</RegionId>
    <Cipher>AES-128-CBC</Cipher>
    <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
    <Connections>0</Connections>
    <SslVpnServerId>vss-bp18q7hzj6largv4v****</SslVpnServerId>
    <MaxConnections>5</MaxConnections>
    <Name>test</Name>
    <EnableMultiFactorAuth>false</EnableMultiFactorAuth>
    <ClientIpPool>10.30.30.0/24</ClientIpPool>
    <Proto>UDP</Proto>
</ModifySslVpnServerResponse>

JSON format

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

{
  "InternetIp" : "47.98.XX.XX",
  "IDaaSInstanceId" : "idaas-cn-hangzhou-****",
  "CreateTime" : 1492753580000,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "Compress" : false,
  "Port" : 1194,
  "LocalSubnet" : "10.20.20.0/24",
  "RegionId" : "cn-hangzhou",
  "Cipher" : "AES-128-CBC",
  "RequestId" : "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "Connections" : 0,
  "SslVpnServerId" : "vss-bp18q7hzj6largv4v****",
  "MaxConnections" : 5,
  "Name" : "test",
  "EnableMultiFactorAuth" : false,
  "ClientIpPool" : "10.30.30.0/24",
  "Proto" : "UDP"
}

Error codes

HttpCode Error code Error message Description
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 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.

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