Queries SSL 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 servers are created.

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

SslVpnServerId String No vss-bp15j3du13gq1dgey****

The ID of the SSL server.

VpnGatewayId String No vpn-bp1on0xae9d771ggi****

The ID of the VPN gateway.

Name String No test

The name of the SSL 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
PageSize Integer 10

The number of entries returned per page.

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

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The number of entries returned.

SslVpnServers Array of SslVpnServer

The detailed information about the SSL servers.

SslVpnServer
InternetIp String 47.5.XX.XX

The public IP address of the VPN gateway.

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

The ID of the Identity as a Service (IDaaS) instance.

CreateTime Long 1613800884000

The timestamp generated when the SSL server was created.

VpnGatewayId String vpn-bp1on0xae9d771ggi****

The ID of the VPN gateway.

IDaaSRegionId String cn-hangzhou

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

Compress Boolean false

Indicates whether data compression is enabled. Valid values:

  • true: yes
  • false (default): no
Port Integer 1194

The port that is used by the SSL server.

LocalSubnet String 192.168.0.0/24

The local CIDR block.

RegionId String cn-hangzhou

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

Cipher String AES-128-CBC

The encryption algorithm.

Connections Integer 0

The total number of current connections.

SslVpnServerId String vss-bp15j3du13gq1dgey****

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 true

Indicates whether two-factor authentication is enabled. Valid values:

  • true: yes
  • false: no
ClientIpPool String 10.10.1.0/24

The client CIDR block.

Proto String UDP

The protocol that is used by the SSL server.

Examples

Sample requests

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

Sample success responses

XML format

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

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

JSON format

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

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

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