You can call this operation to query the connection information about a client based on the ID of the Smart Access Gateway (SAG) APP instance and username of the client account.


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
RegionId String Yes cn-shanghai

The region where the SAG APP instance is deployed.

SmartAGId String Yes sag-wfjgn**********

The ID of the SAG APP instance.

UserName String Yes doctest

The username of the client account. Usernames of client accounts added to the same SAG APP instance are unique.

For a client account, if you specify the username, you must also specify the password.

Action String No DescribeUserOnlineClients

The operation that you want to perform.

Set the value to DescribeUserOnlineClients.

Response parameters

Parameter Type Example Description
RequestId String 7108A98F-C47D-45F7-A4D8-C2E3022735DA

The ID of the request.


The information about the client.

ClientIp String 10.**. **. **

The IP address of the client.

OnlineTime String 1559125519

The time when the client was connected to Alibaba Cloud.


Sample requests

http(s)://[Endpoint]/? Action=DescribeUserOnlineClients
&<Common request parameters>

Sample success responses

XML format


JSON format


Error codes

HttpCode Error code Error message Description
400 ClientUser.NameEmpty You must specify UserName. The error message returned because the username is not specified.
400 ClientUser.NameInvalid The specified UserName is invalid. The error message returned because the format of the username is invalid.
400 SAG.InstanceIdEmpty You must specify the SAG instance ID. The error message returned because the ID of the SAG instance is not specified.
400 SAG.InstanceNoFound The specified SAG instance does not exist. The error message returned because the specified SAG instance does not exist.

For a list of error codes, visit the API Error Center.