Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.
Operation description
- If you do not specify the StartTime or EndTime parameter, the request returns the data collected in the previous 24 hours. If you specify both parameters, the request returns the data collected within the specified time range.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| esa:DescribeSiteTopData | none | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SiteId | integer | No | The website ID, which can be obtained by calling the ListSites operation. If you do not specify this parameter, the system returns data by account. | 1150376036***** |
| StartTime | string | No | The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. | 2023-04-08T16:00:00Z |
| EndTime | string | No | The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note
The end time must be later than the start time.
| 2023-04-09T16:00:00Z |
| Interval | string | No | The time interval between the data entries to return. Unit: seconds. | 300 |
| Fields | array<object> | Yes | The metrics to query. | |
| object | Yes | The metric to query. | ||
| FieldName | string | No | The metric name. | Traffic |
| Dimension | array | No | The dimensions at which you want to query data. | |
| string | No | The dimension at which you want to query data. Note
For more information, see the corresponding log fields.
| ClientZoneCode | |
| Limit | string | No | The number of top-ranking data entries to query. Enumeration Value:
| 5 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": [
{
"FieldName": "Traffic",
"DimensionName": "ALL",
"DetailData": [
{
"DimensionValue": "ALL",
"Value": 123
}
]
}
],
"RequestId": "35C66C7B-671H-4297-9187-2C447724****",
"StartTime": "2023-04-08T16:00:00Z",
"EndTime": "2023-04-09T16:00:00Z",
"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. |
For a list of error codes, visit the Service error codes.
