edit-icon download-icon

DescribeSslVpnServers

Last Updated: Apr 13, 2018

Description

Query the list of SSL-VPN servers.

Request parameters

Name Type Required Description
Action String Yes

The action to perform.

Valid value: DescribeSslVpnServers

RegionId String Yes

The region of the SSL-VPN server.

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

VpnGatewayId String No The ID of the VPN gateway.
SslVpnServerId String No The ID of the SSL-VPN server.
Name String No The name of the SSL-VPN server.
PageNumber Integer No The number of pages to return. The default value is 1.
PageSize Integer No The number of rows per page. The maximum value is 50 and the default value is 10.

Response parameters

Name Type Description
SslVpnServers JSON string A list of SSL-VPN servers.
TotalCount Integer The number of queried entries.
PageNumber Integer The current page number.
PageSize Integer The number of entries on the current page.
SslVpnServers objects
Name Type Description
RegionId String The region of the SSL-VPN server.
SslVpnServerId String The ID of the SSL-VPN server.
VpnGatewayId String The ID of the VPN gateway instance.
Name String The name of the SSL-VPN server.
CLientIpPool Long The IP address pool of the client.
LocalSubnet Long The expiration time of the VPN gateway.
Proto String The protocol used by the SSL-VPN server.
Port Integer The port used by the SSL-VPN server.
Cipher String The encryption algorithm used.
Compress Boolean Whether to compress.
CreateTime String The time of creation.
Connections Integer The number of current connections.
MaxConnections Integer The maximum number of connections.
InternetIp String The public IP.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=DescribeSslVpnServers
  2. &RegionID=cn-beijing
  3. &VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj0fiu
  4. &<CommonParameters>

Response example

XML format

  1. <DescribeSslVpnServersResponse>
  2. <PageNumber>1</PageNumber>
  3. <TotalCount>1</TotalCount>
  4. <PageSize>10</PageSize>
  5. <SslVpnServers>
  6. <SslVpnServer>
  7. <RegionId>cn-hanghzou</RegionId>
  8. <SslVpnServerId>vss-bp18q7hzj6largv4vk2fe</SslVpnServerId>
  9. <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj0fiu</VpnGatewayId>
  10. <Name>test</Name>
  11. <CLientIpPool>10.10.10.20/24</CLientIpPool>
  12. <LocalSubnet>10.10.10.10/24</LocalSubnet>
  13. <Proto>UDP</Proto>
  14. <Port>1194</Port>
  15. <Cipher>AES-128-CBC</Cipher>
  16. <Compress>true</Compress>
  17. <CreateTime>1492753580000</CreateTime>
  18. <Connections>0</Connections>
  19. <MaxConnections>5</MaxConnections>
  20. <InternetIp>47.98.xx.xx</InternetIp>
  21. </SslVpnServer>
  22. </SslVpnServers>
  23. <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
  24. </DescribeSslVpnServersResponse>

JSON format

  1. {
  2. "PageNumber": "1",
  3. "TotalCount": "1",
  4. "PageSize": "10",
  5. "SslVpnServers": {
  6. "SslVpnServer": {
  7. "RegionId": "cn-hanghzou",
  8. "SslVpnServerId": "vss-bp18q7hzj6largv4vk2fe",
  9. "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj0fiu",
  10. "Name": "test",
  11. "CLientIpPool": "10.10.10.20/24",
  12. "LocalSubnet": "10.10.10.10/24",
  13. "Proto": "UDP",
  14. "Port": "1194",
  15. "Cipher": "AES-128-CBC",
  16. "Compress": "true",
  17. "CreateTime": "1492753580000",
  18. "Connections": "0",
  19. "MaxConnections": "5",
  20. "InternetIp": "47.98.xx.xx"
  21. }
  22. },
  23. "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65"
  24. }
Thank you! We've received your feedback.