All Products
Search
Document Center

VPN Gateway:DescribeSslVpnServers

Last Updated:Feb 22, 2024

Queries one or more SSL-VPN servers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeSslVpnServersList
  • SslVpnServer
    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*
  • SslVpnServer
    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the SSL server.

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

cn-hangzhou
SslVpnServerIdstringNo

The ID of the SSL server.

vss-bp15j3du13gq1dgey****
VpnGatewayIdstringNo

The ID of the VPN gateway.

vpn-bp1on0xae9d771ggi****
NamestringNo

The SSL server name.

The name must be 1 to 100 characters in length and cannot start with http:// or https://.

test
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
ResourceGroupIdstringNo

The ID of the resource group to which the SSL server belongs.

The SSL server has the same resource group as its associated VPN gateway instance.

You can call the DescribeVpnGateway operation to query the ID of the resource group to which the VPN gateway instance belongs.

rg-acfmzs372yg****

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

D350187B-EA41-4577-950B-95434C8302E1
PageNumberinteger

The number of the page to return.

1
TotalCountinteger

The number of entries returned.

1
SslVpnServersobject []

The detailed information about the SSL servers.

InternetIpstring

The public IP address of the VPN gateway.

47.5.XX.XX
IDaaSInstanceIdstring

The ID of the IDaaS instance.

idaas-cn-hangzhou-****
CreateTimelong

The timestamp generated when the SSL server was created.

1613800884000
VpnGatewayIdstring

The ID of the VPN gateway.

vpn-bp1on0xae9d771ggi****
IDaaSRegionIdstring

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

cn-hangzhou
Compressboolean

Indicates whether data compression is enabled. Valid values:

  • true
  • false (default)
false
Portinteger

The port that is used by the SSL server.

1194
LocalSubnetstring

The local CIDR block.

192.168.0.0/24
RegionIdstring

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

cn-hangzhou
Cipherstring

The encryption algorithm.

AES-128-CBC
Connectionsinteger

The total number of current connections.

0
SslVpnServerIdstring

The ID of the SSL server.

vss-bp15j3du13gq1dgey****
MaxConnectionsinteger

The maximum number of connections.

5
Namestring

The name of the SSL server.

test
EnableMultiFactorAuthboolean

Indicates whether two-factor authentication is enabled.

  • true
  • false (default)
true
ClientIpPoolstring

The client CIDR block.

10.10.1.0/24
Protostring

The protocol that is used by the SSL server.

UDP
ResourceGroupIdstring

The ID of the resource group to which the SSL server belongs.

You can call the ListResourceGroups operation to query the resource group information.

rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "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",
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
403ForbiddenUser not authorized to operate on the specified resource.You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404InvalidRegionId.NotFoundThe specified region is not found during access authentication.The specified area is not found during authentication.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-19API Description Update. The API operation is not deprecated.. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
API Deprecation DescriptionThe API operation is not deprecated..
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.