You can call this operation to query the data transfer statistics of clients added to a specific Smart Access Gateway (SAG) APP instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
RegionId | String | Yes | cn-hangzhou |
The region where the SAG APP instance is deployed. |
SmartAGId | String | Yes | sag-mfkg***** |
The ID of the SAG APP instance. |
UserNames.N | RepeatList | Yes | 12 |
The list of usernames of client accounts. Maximum value of N: 50. |
Action | String | No | DescribeUserFlowStatistics |
The operation that you want to perform. Set the value to DescribeUserOnlineClients. |
StatisticsDate | String | No | 201905 |
The month during which the data transfer statistics are collected. If you do not specify a month, the current month is queried. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 9552AD68-18EA-4074-B27D-40040FBA9683 |
The ID of the request. |
SagStatistics |
The statistics of data transfer. |
||
TotalBytes | String | 12 |
The amount of data consumed. Unit: byte. |
UserName | String | doctest |
The username of the client account. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeUserFlowStatistics
&RegionId=cn-hangzhou
&SmartAGId=sag-mfkg*****
&UserNames.1=12
&<Common request parameters>
Sample success responses
XML
format
<DescribeUserFlowStatisticsResponse>
<SagStatistics>
<Statistics>
<UserName>zhanlg</UserName>
<TotalBytes>555352</TotalBytes>
</Statistics>
</SagStatistics>
<RequestId>ADD09081-31A9-4E7D-B15C-135C6EBEEB63</RequestId>
</DescribeUserFlowStatisticsResponse>
JSON
format
{
"RequestId":"ADD09081-31A9-4E7D-B15C-135C6EBEEB63",
"SagStatistics":{
"Statistics":[
{
"UserName":"zhanlg",
"TotalBytes":555352
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
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.