Retrieve Site Traffic Time Series Data via DescribeSiteTimeSeriesData API - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Query traffic analysis time series data

Operation description

If you do not specify StartTime and EndTime, the API returns data for the past 24 hours; if you specify StartTime and EndTime, the API returns data for the specified time period.
The API returns different time granularities based on the span between StartTime and EndTime.
- For a span of 3 hours or less, it returns 1-minute granularity data.
- For a span greater than 3 hours but no more than 12 hours, it returns 5-minute granularity data.
- For a span greater than 12 hours but no more than 1 day, it returns 15-minute granularity data.
- For a span greater than 1 day but no more than 10 days, it returns hourly granularity data.
- For a span greater than 10 days but no more than 31 days, it returns daily granularity data.
Due to the high number of accesses during the query period, the data analysis may be sampled.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:DescribeSiteTimeSeriesData

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	string	No	Site ID. Obtain the site ID by calling the ListSites interface. If this parameter is empty, user-level data will be queried.	1150376036*****
StartTime	string	No	The start time for obtaining data. The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ.	2023-04-08T16:00:00Z
EndTime	string	No	The end time for obtaining data. The date format follows ISO8601 notation and uses UTC+0 time, in the format yyyy-MM-ddTHH:mm:ssZ. Note The end time must be later than the start time.	2023-04-09T16:00:00Z
Interval	string	No	The time granularity for querying data, in seconds. Depending on the maximum time span of a single query, this parameter supports values of 60 (1 minute), 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For details, see the Supported Query Time Granularities.	300
Fields	array<object>	Yes	Query metrics.
	object	No	Query metrics.
FieldName	string	No	Query metric value. Note For specific dimensions, see Data Analysis Field Description.	Traffic
Dimension	array	No	Query dimension.
	string	No	Query dimension. Note For specific dimensions, see Data Analysis Field Description.	ALL

Response elements

Element	Type	Description	Example
	object
Data	array<object>	Returned data.
	array<object>	Returned data.
FieldName	string	Query metric value.	Traffic
DimensionName	string	Query dimension.	ALL
DimensionValue	string	Query dimension value.	ALL
DetailData	array<object>	Returned data.
	object	Returned data.
TimeStamp	string	Start timestamp of the time slice.	2023-04-08T16:00:00Z
Value	any	Value.	123
SummarizedData	array<object>	Aggregated query data.
	object
FieldName	string	The value of the aggregated metric being queried.	Traffic
DimensionName	string	The dimension of the aggregated data being queried.	ALL
DimensionValue	string	The value of the aggregated dimension being queried.	ALL
AggMethod	string	The aggregation method used.	sum
Value	any	The aggregated value.	12345
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE7****
StartTime	string	The start time for fetching the data. The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.	2023-04-08T16:00:00Z
EndTime	string	The end time for fetching the data. The date format follows ISO8601 notation and uses UTC+0, formatted as yyyy-MM-ddTHH:mm:ssZ.	2023-04-09T16:00:00Z
Interval	integer	The granularity of the data, in seconds.	300
SamplingRate	number	The sampling rate, in %.	100

Examples

Success response

JSON format

{
  "Data": [
    {
      "FieldName": "Traffic",
      "DimensionName": "ALL",
      "DimensionValue": "ALL",
      "DetailData": [
        {
          "TimeStamp": "2023-04-08T16:00:00Z",
          "Value": "123"
        }
      ]
    }
  ],
  "SummarizedData": [
    {
      "FieldName": "Traffic",
      "DimensionName": "ALL",
      "DimensionValue": "ALL",
      "AggMethod": "sum",
      "Value": "12345"
    }
  ],
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****",
  "StartTime": "2023-04-08T16:00:00Z",
  "EndTime": "2023-04-09T16:00:00Z",
  "Interval": 300,
  "SamplingRate": 100
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.	The specified time range exceeds the limit. Adjust it and try again.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.
400	QuotaCheckFailed.Function	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.	The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
400	InvalidParameter.Field	The specified Field is invalid.	The specified Field is invalid. For more information, see OpenAPI Documentation .
400	InvalidParameter.Dimension	The specified Dimension is invalid.	The specified Dimension is invalid. For more information, see OpenAPI Documentation .
400	InvalidTime.Malformed	Specified start time or end time is malformed.	The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.
400	TooManyDimensions	Too many query dimensions specified. Delete some and try again.	Too many query dimensions specified. Delete some and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.