Queries SSL-VPN servers.

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 DescribeSslVpnServers

The name of this action. Value:

DescribeSslVpnServers

RegionId String Yes cn-hangzhou

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

To query the region ID, call DescribeRegions.

Name String No test The name of the SSL-VPN server.
PageNumber Integer No 1 The number of pages to return. Default value: 1.
PageSize Integer No 10 The number of rows per page. Maximum value: 50. Default value: 10.
SslVpnServerId String No vss-bp15j3du13gq1dgeypy1q The ID of the SSL-VPN server.
VpnGatewayId String No vpn-bp1on0xae9d771ggiomqe The ID of the VPN Gateway.

Response parameters

Parameter Type Example value Description
PageNumber Integer 1

The current page number.

PageSize Integer 10

The number of entries per page.

RequestId String 085CA5EA-1E76-43A8-981B-E0208DECA0CB

The ID of the request.

SslVpnServers N/A N/A

A list of SSL-VPN servers.

 └Cipher String AES-128-CBC

The encryption algorithm used.

 └ClientIpPool String 10.10.1.0/24

The IP address pool of the client.

 └Compress Boolean false

Indicates whether to compress the communication.

 └Connections Integer 0

The number of current connections.

 └CreateTime Long 1544668844000

The time when the SSL-VPN server was created.

 └InternetIp String 47.96.167.xxx

The public IP address.

 └LocalSubnet String 192.168.0.0/24

The CIDR block of the 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 used by the SSL-VPN server.

 └Proto String UDP

The protocol used by the SSL-VPN server.

 └RegionId String cn-hangzhou

The region of the SSL-VPN server.

 └SslVpnServerId String vss-bp15j3du13gq1dgeypy1q

The ID of the SSL-VPN server.

 └VpnGatewayId String vpn-bp1on0xae9d771ggiomqe

The ID of the VPN Gateway.

TotalCount Integer 1

The number of queried entries.

Examples

Request example


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

    <DescribeSslVpnServersResponse>
      <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.10.10.20/24</CLientIpPool>
          <LocalSubnet>10.10.10.10/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>
    </DescribeSslVpnServersResponse>
    
  • JSON format

    {
    	"PageNumber":"1",
    	"TotalCount":"1",
    	"SslVpnServers":{
    		"SslVpnServer":{
    			"VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj0fiu",
    			"CLientIpPool":"10.10.10.20/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.10.10.10/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.

See common error codes