Modifies the configurations of an SSL-VPN server.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

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-bp18q7hzj6largv4v****

The ID of the SSL-VPN server.

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.

Name String No test

The name of the SSL-VPN server.

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

ClientIpPool String No 10.30.30.0/2

The IP address pool of the client.

LocalSubnet String No 10.20.20.0/24

The CIDR block of the local client.

Proto String No UDP

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

  • TCP: TCP protocol
  • UDP(default): UDP protocol
Cipher String No AES-128-CBC

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

  • 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.
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.

Compress Boolean No false

Indicates whether to compress the communication. Valid values:

  • true (default): Compresses the communication.
  • false: Do not compress the communication.

Response parameters

Parameter Type Example value Description
RequestId String DF11D6F6-E35A-41C3-9B20-6FC8A901FE65

The ID of the request.

RegionId String cn-hangzhou

The region of the SSL-VPN server.

SslVpnServerId String vss-bp18q7hzj6largv4v****

The ID of the SSL-VPN server.

VpnGatewayId String vpn-bp1q8bgx4xnkm2ogj****

The ID of the VPN Gateway instance.

Name String test

The name of the SSL-VPN server.

LocalSubnet String 10.20.20.0/24

The CIDR block of the local client.

ClientIpPool String 10.30.30.0/24

The IP address pool of the client.

CreateTime Long 1492753580000

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

Cipher String AES-128-CBC

The encryption algorithm used.

Proto String UDP

The protocol used by the SSL-VPN server.

Port Integer 1194

The port of the SSL-VPN server.

Compress Boolean false

Indicates whether to compress the communication.

Connections Integer 0

The number of currnet connections.

MaxConnections Integer 5

The maximum number of connections.

InternetIp String 47.98.xx.xx

The public IP address.

Examples

Request example

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

Response example

XML format

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

Errors

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.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource.
400 InvalidName The name is not valid The name format is invalid.
400 VpnGateway.Configuring The specified service is configuring. The specified service is being configured.
400 VpnGateway.FinancialLocked The specified service is financial locked. The specified service is locked due to insufficient account balance.

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