DescribeUserOnlineClientStatistics - Smart Access Gateway

Queries the number of clients that are connected to Alibaba Cloud through a specific Smart Access Gateway (SAG) app instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:DescribeUserOnlineClientStatistics	Read	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	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-sfjg*****
UserNames	array	Yes
	string	Yes	The username.	doctest

Response parameters

Parameter	Type	Description	Example
	object
UserStatistics	object []	The connection information about the specified clients.
OnlineCount	string	The number of clients that are connected to Alibaba Cloud.	2
UserName	string	The username.	doctest
RequestId	string	The ID of the request.	14846A6A-2192-4F6A-B272-B8BD68EBC89B

Examples

Sample success responses

JSONformat

{
  "UserStatistics": {
    "Statistics": [
      {
        "OnlineCount": "2",
        "UserName": "doctest"
      }
    ]
  },
  "RequestId": "14846A6A-2192-4F6A-B272-B8BD68EBC89B"
}

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.

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