All Products
Search

This Product

    VPN Gateway:DescribeSslVpnServers

    Document Center

    VPN Gateway:DescribeSslVpnServers

    Last Updated:Jun 25, 2026

    Queries the SSL servers that have been created by calling the DescribeSslVpnServers operation.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    vpc:DescribeSslVpnServers

    list

    SslVpnServer

    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*

    SslVpnServer

    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID of the SSL server.

    You can call the DescribeRegions operation to query the region ID.

    cn-hangzhou
    SslVpnServerId

    string

    No

    The ID of the SSL server.

    vss-bp15j3du13gq1dgey****
    VpnGatewayId

    string

    No

    The ID of the VPN gateway.

    vpn-bp1on0xae9d771ggi****
    Name

    string

    No

    The name of the SSL server.

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

    test
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

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

    10
    ResourceGroupId

    string

    No

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

    The SSL server belongs to the same resource group as the associated VPN gateway instance. You can call the DescribeVpnGateway operation to query the resource group ID of the VPN gateway instance.

    rg-acfmzs372yg****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    PageSize

    integer

    The number of entries per page in paging query.

    10
    RequestId

    string

    The request ID.

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

    integer

    The page number.

    1
    TotalCount

    integer

    The total number of entries returned.

    1
    SslVpnServers

    object

    SslVpnServer

    array<object>

    The details of the SSL server.

    object

    InternetIp

    string

    The public IP address of the VPN gateway.

    47.5.XX.XX
    IDaaSInstanceId

    string

    The ID of the IDaaS EIAM instance.

    idaas-cn-hangzhou-****
    CreateTime

    integer

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

    1613800884000
    VpnGatewayId

    string

    The ID of the VPN gateway.

    vpn-bp1on0xae9d771ggi****
    IDaaSRegionId

    string

    The region ID of the IDaaS EIAM instance.

    cn-hangzhou
    Compress

    boolean

    Indicates whether data compression is enabled. Valid values:

    • true

    • false (default)

    false
    Port

    integer

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

    1194
    LocalSubnet

    string

    The local CIDR block.

    192.168.0.0/24
    RegionId

    string

    The region ID of the SSL server.

    cn-hangzhou
    Cipher

    string

    The encryption algorithm.

    AES-128-CBC
    Connections

    integer

    The total number of current connections.

    0
    SslVpnServerId

    string

    The ID of the SSL server.

    vss-bp15j3du13gq1dgey****
    MaxConnections

    integer

    The maximum number of connections.

    5
    Name

    string

    The name of the SSL server.

    test
    EnableMultiFactorAuth

    boolean

    Indicates whether two-factor authentication is enabled.

    • true

    • false (default)

    true
    ClientIpPool

    string

    The client CIDR block.

    10.10.1.0/24
    Proto

    string

    The protocol that is used by the SSL server.

    UDP
    ResourceGroupId

    string

    The resource group ID of the SSL server.

    You can call the ListResourceGroups operation to query resource groups.

    rg-acfmzs372yg****
    IDaaSApplicationId

    string

    The ID of the IDaaS application.

    app_my6g4qmvnwxzj2f****
    IDaaSInstanceVersion

    string

    The version of the IDaaS EIAM instance.

    • This parameter is returned only if the SSL server is associated with an IDaaS EIAM 2.0 instance. Only EIAM 2.0 is returned.

    • If the SSL server is associated with an IDaaS EIAM 1.0 instance, no value is returned.

    EIAM 2.0
    DnsServers

    string

    Examples

    Success response

    JSON format

    {
  "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****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0",
        "DnsServers": ""
      }
    ]
  }
}

    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.
    403 Forbidden User 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.
    404 InvalidRegionId.NotFound The specified region is not found during access authentication. The specified area is not found during authentication.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.