Queries SSL-VPN servers.

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 DescribeSslVpnServers

The operation that you want to perform.

Set the value to DescribeSslVpnServers.

RegionId String Yes cn-hangzhou

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

You can call the DescribeRegions operation to query region IDs.

SslVpnServerId String No vss-bp15j3du13gq1dgey****

The ID of the SSL-VPN server.

VpnGatewayId String No vpn-bp1on0xae9d771ggi****

The ID of the VPN gateway.

Name String No test

The name of the SSL-VPN server.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned on each page.

RequestId String D350187B-EA41-4577-950B-95434C8302E1

The ID of the request.

SslVpnServers Array of SslVpnServer

The detailed information about the SSL-VPN server.

SslVpnServer
Cipher String AES-128-CBC

The encryption algorithm.

ClientIpPool String 10.10.1.0/24

The client CIDR block.

Compress Boolean false

Indicates whether data compression is enabled.

Connections Integer 0

The total number of current connections.

CreateTime Long 1613800884000

The timestamp generated when the SSL-VPN server is created.

EnableMultiFactorAuth Boolean true

Indicates whether two-factor authentication is enabled.

  • true: two-factor authentication is enabled.
  • false (default): two-factor authentication is disabled.
IDaaSInstanceId String idaas-cn-hangzhou-****

The ID of the IDaaS instance.

IDaaSRegionId String cn-hangzhou

The ID of the region where the IDaaS instance is deployed.

InternetIp String 47.XX.XX.5

The public IP address of the VPN gateway.

LocalSubnet String 192.168.0.0/24

The local CIDR block.

MaxConnections Integer 5

The maximum number of connections.

Name String test

The name of the SSL-VPN server.

Port Integer 1194

The port that is used by the SSL-VPN server.

Proto String UDP

The protocol that is used by the SSL-VPN server.

RegionId String cn-hangzhou

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

SslVpnServerId String vss-bp15j3du13gq1dgey****

The ID of the SSL-VPN server.

VpnGatewayId String vpn-bp1on0xae9d771ggi****

The ID of the VPN gateway.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeSslVpnServers
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<DescribeSslVpnServersResponse>
  <TotalCount>1</TotalCount>
  <RequestId>D350187B-EA41-4577-950B-95434C8302E1</RequestId>
  <PageSize>10</PageSize>
  <PageNumber>1</PageNumber>
  <SslVpnServers>
        <SslVpnServer>
              <LocalSubnet>10.10.1.0/24</LocalSubnet>
              <Compress>true</Compress>
              <Connections>0</Connections>
              <ClientIpPool>192.168.0.0/24</ClientIpPool>
              <IDaaSInstanceId>idaas-cn-hangzhou-p****</IDaaSInstanceId>
              <MaxConnections>5</MaxConnections>
              <EnableMultiFactorAuth>true</EnableMultiFactorAuth>
              <SslVpnServerId>vss-bp1phv0j000c78l3k****</SslVpnServerId>
              <CreateTime>1613800884000</CreateTime>
              <Port>1194</Port>
              <IDaaSRegionId>cn-hangzhou</IDaaSRegionId>
              <Name>test</Name>
              <Proto>TCP</Proto>
              <InternetIp>47.XX.XX.5</InternetIp>
              <VpnGatewayId>vpn-bp17lofy9fd0dnvzv****</VpnGatewayId>
              <RegionId>cn-hangzhou</RegionId>
              <Cipher>AES-128-CBC</Cipher>
        </SslVpnServer>
  </SslVpnServers>
</DescribeSslVpnServersResponse>

JSON format

{
  "TotalCount": 1,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageSize": 10,
  "PageNumber": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "LocalSubnet": "10.10.1.0/24",
        "Compress": true,
        "Connections": 0,
        "ClientIpPool": "192.168.0.0/24",
        "IDaaSInstanceId": "idaas-cn-hangzhou-p****",
        "MaxConnections": 5,
        "EnableMultiFactorAuth": true,
        "SslVpnServerId": "vss-bp1phv0j000c78l3k****",
        "CreateTime": 1613800884000,
        "Port": 1194,
        "IDaaSRegionId": "cn-hangzhou",
        "Name": "test",
        "Proto": "TCP",
        "InternetIp": "47.XX.XX.5",
        "VpnGatewayId": "vpn-bp17lofy9fd0dnvzv****",
        "RegionId": "cn-hangzhou",
        "Cipher": "AES-128-CBC"
      }
    ]
  }
}

Error codes

HttpCode 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. The error message returned because you are unauthorized to perform the operation on the specified resource. You can apply for the 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. To acquire the required permissions, submit a ticket.

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