Queries the number of clients connected to Alibaba Cloud through a 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSagOnlineClientStatistics

The operation that you want to perform. Set the value to DescribeSagOnlineClientStatistics.

RegionId String Yes cn-shanghai

The ID of the region where the SAG app instance is deployed.

SmartAGIds.N String No sag-6z21oj0vjjrx6s****

The ID of the SAG app instance.

Response parameters

Parameter Type Example Description
SagStatistics Array of Statistics

The information about the clients that are connected to Alibaba Cloud.

Statistics
SmartAGId String sag-va03wf4l4idaj*****

The ID of the SAG app instance.

OnlineCount String 0

The number of clients that are connected to Alibaba Cloud through the specified SAG APP instance.

RequestId String 9EC839B6-0EA5-4F19-A4B7-A9E465D057AE

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSagOnlineClientStatistics
&RegionId=cn-shanghai
&SmartAGIds=["sag-6z21oj0vjjrx6s****"]
&Common request parameters

Sample success responses

XML format 

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

<?xml version="1.0" encoding="UTF-8" ?>
    <DescribeSagOnlineClientStatisticsResponse>
	<RequestId>9EC839B6-0EA5-4F19-A4B7-A9E465D057AE</RequestId>
	<SagStatistics>
		<Statistics>
			<SmartAGId>sag-va03wf4l4idaj0***</SmartAGId>
			<OnlineCount>0</OnlineCount>
		</Statistics>
	</SagStatistics>
    </DescribeSagOnlineClientStatisticsResponse>

JSON format 

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

{
  "RequestId" : "9EC839B6-0EA5-4F19-A4B7-A9E465D057AE",
  "SagStatistics" : {
    "Statistics" : [ {
      "SmartAGId" : "sag-va03wf4l4idaj00***",
      "OnlineCount" : 0
    } ]
  }
}

Error codes

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