DescribeSslVpnClients API Reference - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries information about clients that have established SSL-VPN connections to Alibaba Cloud under a specified VPN gateway instance by calling the DescribeSslVpnClients operation.

Operation description

If your VPN gateway instance was created before December 10, 2022, you must upgrade the VPN gateway instance to the latest version before you can view SSL client connection information. For more information, see Upgrade a VPN gateway.

VPN gateway instances created after December 10, 2022 support viewing SSL client connection information by default.

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:DescribeSslVpnClients

list

*VpnGateway

acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPN gateway instance. You can call the DescribeRegions operation to query the region ID.	eu-central-1
VpnGatewayId	string	Yes	The VPN gateway instance ID.	vpn-gw8gfb947ctddabja****
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The maximum number of entries per page in a paged query. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayId	string	The VPN gateway instance ID.	vpn-gw8gfb947ctddabja****
PageNumber	integer	The page number of the list.	1
PageSize	integer	The maximum number of entries per page in a paged query.	10
TotalCount	integer	The total number of entries in the list.	1
RegionId	string	The region ID of the VPN gateway instance.	eu-central-1
ClientInfoList	array<object>	The list of client information.
	object	The client information.
Status	string	The status of the SSL-VPN connection. Valid values: online, which indicates that the client has successfully established an SSL-VPN connection to Alibaba Cloud.	online
PrivateIp	string	The private IP address that the VPN gateway assigned to the client when the client established an SSL-VPN connection to Alibaba Cloud.	10.10.10.10
SendBytes	integer	The traffic that the VPN gateway sent to the client over the SSL-VPN connection. Unit: bytes.	57144
ConnectedTime	integer	The timestamp when the client established the SSL-VPN connection to Alibaba Cloud. Unit: milliseconds. The timestamp is in the UNIX format and represents the total number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC to the time when the SSL-VPN connection was established.	1670985008000
CommonName	string	The SSL client certificate used by the client to establish the SSL-VPN connection to Alibaba Cloud. Note If the client uses two-factor identity authentication to establish the SSL-VPN connection to Alibaba Cloud, the value of this parameter is the username of the client.	CN=vsc-gw8gkh6gtilf1whgc****
Ip	string	The public IP address that the client used to establish the SSL-VPN connection to Alibaba Cloud.	8.XX.XX.15
ReceiveBytes	integer	The traffic that the VPN gateway received from the client over the SSL-VPN connection. Unit: bytes.	60782
Port	string	The port number that the client used to establish the SSL-VPN connection to Alibaba Cloud.	4****

Examples

Success response

JSON format

{
  "RequestId": "885E117D-06A9-38A3-8DD2-40BDAC429FFC",
  "VpnGatewayId": "vpn-gw8gfb947ctddabja****",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RegionId": "eu-central-1",
  "ClientInfoList": [
    {
      "Status": "online",
      "PrivateIp": "10.10.10.10",
      "SendBytes": 57144,
      "ConnectedTime": 1670985008000,
      "CommonName": "CN=vsc-gw8gkh6gtilf1whgc****",
      "Ip": "8.XX.XX.15",
      "ReceiveBytes": 60782,
      "Port": "4****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
400	InvalidInstanceId.NotFound	The specified instance id does not exist.	The specified instance ID does not exist.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.