DescribeUserFlowStatistics - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the amount of data transfer generated by each client account of 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

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:DescribeUserFlowStatistics	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-hangzhou
SmartAGId	string	Yes	The ID of the SAG APP instance.	sag-mfkg*****
StatisticsDate	string	No	The month during which the data transfer statistics are collected. If you do not specify a month, the current month is queried.	201905
UserNames	array	Yes	The list of usernames of client accounts. Maximum value of N: 50.
	string	Yes	The username of the client account.	doctest

Response parameters

Parameter	Type	Description	Example
	object	The response.
SagStatistics	object []	The statistics of data transfer.
TotalBytes	string	The amount of data consumed. Unit: byte.	12
UserName	string	The username of the client account.	doctest
TotalLeaveBytes	string	The remaining quota of the free data transfer plan. Unit: bytes.	1000
RequestId	string	The ID of the request.	9552AD68-18EA-4074-B27D-40040FBA9683

Examples

Sample success responses

JSONformat

{
  "SagStatistics": {
    "Statistics": [
      {
        "TotalBytes": "12",
        "UserName": "doctest",
        "TotalLeaveBytes": "1000"
      }
    ]
  },
  "RequestId": "9552AD68-18EA-4074-B27D-40040FBA9683"
}

Error codes

HTTP status code	Error code	Error message	Description
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.

Change history

Change time

Summary of changes

Operation

2023-04-06

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
Output Parameters	The response structure of the API has changed.