All Products
Search
Document Center

Virtual Private Cloud:DescribeSslVpnClients

Last Updated:Nov 13, 2024

Queries the clients that have connected to a VPN gateway through SSL-VPN connections.

Operation description

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

If your VPN gateway was created after December 10, 2022, you can view connection information about SSL clients by default.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DescribeSslVpnClientslist
  • VpnGateway
    acs:vpc:{#regionId}:{#accountId}:vpngateway/{#VpnGatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the VPN gateway.

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

eu-central-1
VpnGatewayIdstringYes

The ID of the VPN gateway.

vpn-gw8gfb947ctddabja****
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

885E117D-06A9-38A3-8DD2-40BDAC429FFC
VpnGatewayIdstring

The ID of the VPN gateway.

vpn-gw8gfb947ctddabja****
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The number of returned entries.

1
RegionIdstring

The region ID.

eu-central-1
ClientInfoListarray<object>

The list of clients.

ClientInfoobject

The information of clients.

Statusstring

The status of the SSL-VPN connection.

The value is set to online, which indicates that the client has connected to Alibaba Cloud through an SSL-VPN connection.

online
PrivateIpstring

The private IP address allocated to the client by the VPN gateway when the client established an SSL-VPN connection to Alibaba Cloud.

10.10.10.10
SendByteslong

The amount of data transferred from the VPN gateway to the client through the SSL-VPN connection. Unit: bytes.

57144
ConnectedTimelong

The timestamp that indicates when the client connected to Alibaba Cloud through an SSL-VPN connection. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1670985008000
CommonNamestring

The SSL client certificate used by the client.

Note If the client uses two-factor authentication to establish an SSL-VPN connection to Alibaba Cloud, the return value is the username of the client.
CN=vsc-gw8gkh6gtilf1whgc****
Ipstring

The actual public IP address used by the client when the client established an SSL-VPN connection to Alibaba Cloud.

8.XX.XX.15
ReceiveByteslong

The amount of data transferred from the client to the VPN gateway through the SSL-VPN connection. Unit: bytes.

60782
Portstring

The port used by the client when the client established an SSL-VPN connection to Alibaba Cloud.

4****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidVpnGatewayInstanceId.NotFoundThe specified vpn gateway instance id does not exist.The specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
400InvalidInstanceId.NotFoundThe specified instance id does not exist.The specified instance ID does not exist.
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.

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

Change history

Change timeSummary of changesOperation
No change history