DescribeSslVpnClients - - Alibaba Cloud ドキュメントセンター

Usage notes

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

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	DescribeSslVpnClients	The operation that you want to perform. Set the value to DescribeSslVpnClients.
RegionId	String	Yes	eu-central-1	The region ID of the VPN gateway. You can call the DescribeRegions operation to query the most recent region list.
VpnGatewayId	String	Yes	vpn-gw8gfb947ctddabja****	The ID of the VPN gateway.
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. Valid values: 1 to 50. Default value: 10.

Response parameters


Parameter	Type	Example	Description
RequestId	String	885E117D-06A9-38A3-8DD2-40BDAC429FFC	The ID of the request.
VpnGatewayId	String	vpn-gw8gfb947ctddabja****	The ID of the VPN gateway.
PageNumber	Integer	1	The number of the returned page.
PageSize	Integer	10	The number of entries returned per page.
TotalCount	Integer	1	The number of entries returned.
RegionId	String	eu-central-1	The region ID of the VPN gateway.
ClientInfoList	Array of ClientInfo		The list of clients.
Status	String	online	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.
PrivateIp	String	10.10.10.10	The private IP address allocated to the client by the VPN gateway when the client established an SSL-VPN connection to Alibaba Cloud.
SendBytes	Long	57144	The amount of data transferred from the VPN gateway to the client through the SSL-VPN connection. Unit: bytes.
ConnectedTime	Long	1670985008000	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 the epoch time January 1, 1970, 00:00:00 UTC.
CommonName	String	CN=vsc-gw8gkh6gtilf1whgc****	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 value is the username of the client.
Ip	String	8.XX.XX.15	The actual public IP address used by the client when the client established an SSL-VPN connection to Alibaba Cloud.
ReceiveBytes	Long	60782	The amount of data transferred from the client to the VPN gateway through the SSL-VPN connection. Unit: bytes.
Port	String	4****	The port used by the client when the client established an SSL-VPN connection to Alibaba Cloud.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSslVpnClients
&RegionId=eu-central-1
&VpnGatewayId=vpn-gw8gfb947ctddabja****
&PageNumber=1
&PageSize=10
&Common request parameters

Sample success responses

XML format

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

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

JSON format

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

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

Error codes


HttpCode	Error code	Error message	Description
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	The error message returned because the specified VPN gateway does not exist. Check whether the specified VPN gateway is valid.
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. Acquire the required permissions and try again.
403	Forbidden	User not authorized to operate on the specified resource.	The error message returned because you are not authorized to perform the operation on the specified resource. Acquire the required permissions and try again.

For a list of error codes, see Service error codes.