DescribeSagOnlineClientStatistics - Smart Access Gateway

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the SAG app instance is deployed.	cn-shanghai
SmartAGIds	array	No
	string	No	The ID of the SAG app instance.	sag-6z21oj0vjjrx6s****

Response parameters

Parameter	Type	Description	Example
	object
SagStatistics	object []	The information about the clients that are connected to Alibaba Cloud.
SmartAGId	string	The ID of the SAG app instance.	sag-va03wf4l4idaj*****
OnlineCount	string	The number of clients that are connected to Alibaba Cloud through the specified SAG APP instance.	0
RequestId	string	The ID of the request.	9EC839B6-0EA5-4F19-A4B7-A9E465D057AE

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidId.SMARTAG	The specified smart access gateway instance ID does not exist.

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