Use DescribeUserOnlineClients to query online clients - Smart Access Gateway

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

smartag:DescribeUserOnlineClients

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region where the SAG APP instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG APP instance.	sag-wfjgn**********
UserName	string	Yes	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.	doctest

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	7108A98F-C47D-45F7-A4D8-C2E3022735DA
Users	object
User	array<object>	The information about the client.
	object
ClientIp	string	The IP address of the client.	10...**
OnlineTime	string	The time when the client was connected to Alibaba Cloud.	1559125519

Examples

Success response

JSON format

{
  "RequestId": "7108A98F-C47D-45F7-A4D8-C2E3022735DA",
  "Users": {
    "User": [
      {
        "ClientIp": "10.**.**.**",
        "OnlineTime": "1559125519"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ClientUser.NameEmpty	You must specify UserName.	You must enter a username.
400	ClientUser.NameInvalid	The specified UserName is invalid.	The format of the username is invalid.
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.