All Products
Search
Document Center

Smart Access Gateway:DescribeUserFlowStatistics

Last Updated:Mar 29, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:DescribeUserFlowStatisticsRead
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region where the SAG APP instance is deployed.

cn-hangzhou
SmartAGIdstringYes

The ID of the SAG APP instance.

sag-mfkg*****
StatisticsDatestringNo

The month during which the data transfer statistics are collected.

If you do not specify a month, the current month is queried.

201905
UserNamesarrayYes

The list of usernames of client accounts. Maximum value of N: 50.

stringYes

The username of the client account.

doctest

Response parameters

ParameterTypeDescriptionExample
object

The response.

SagStatisticsobject []

The statistics of data transfer.

TotalBytesstring

The amount of data consumed. Unit: byte.

12
UserNamestring

The username of the client account.

doctest
TotalLeaveBytesstring

The remaining quota of the free data transfer plan. Unit: bytes.

1000
RequestIdstring

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 codeError codeError messageDescription
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe 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 timeSummary of changesOperation
2023-04-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.