查询账户维度或站点维度流量分析时序数据。
接口说明
如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。
- 根据 StartTime 和 EndTime 跨度返回不同时间粒度。
小于等于 3 小时，返回 1 分钟粒度数据。
跨度大于 3 小时且小于等于 12 小时, 返回 5 分钟粒度数据。
跨度大于 12 小时且小于等于 1 天, 返回 15 分钟粒度数据。
跨度大于 1 天且小于等于 10 天，返回小时粒度数据。
跨度大于 10 天且小于等于 31 天返回天粒度数据。
由于查询时间段的访问次数较大，数据分析可能经过采样。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
esa:DescribeSiteTimeSeriesData |
none |
*Site
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SiteId |
string |
否 |
站点 ID。通过调用 ListSites 接口获取站点 ID。 此参数为空时查询用户维度数据。 |
1150376036***** |
| StartTime |
string |
否 |
获取数据的起始时间。 日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-04-08T16:00:00Z |
| EndTime |
string |
否 |
获取数据的结束时间。 日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。 |
2023-04-09T16:00:00Z |
| Interval |
string |
否 |
查询数据的时间粒度，单位为秒。 根据单次查询的最大时间跨度不同，该参数支持 60(一分钟) 、300(5 分钟)、3600(1 小时)和 86400(1 天)取值，具体请参见上方的支持查询的时间粒度。 |
300 |
| Fields |
array<object> |
是 |
查询指标。 |
|
|
object |
否 |
查询指标。 |
||
| FieldName |
string |
否 |
查询指标值。 说明
具体维度请参见数据分析字段说明。 |
Traffic |
| Dimension |
array |
否 |
查询维度。 |
|
|
string |
否 |
查询维度。 说明
具体维度请参见数据分析字段说明。 |
ALL |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Data |
array<object> |
返回数据。 |
|
|
array<object> |
返回数据。 |
||
| FieldName |
string |
查询指标值。 |
Traffic |
| DimensionName |
string |
查询维度。 |
ALL |
| DimensionValue |
string |
查询维度值。 |
ALL |
| DetailData |
array<object> |
返回数据。 |
|
|
object |
返回数据。 |
||
| TimeStamp |
string |
时间片起始时刻。 日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-04-08T16:00:00Z |
| Value |
any |
数值。 |
123 |
| SummarizedData |
array<object> |
查询汇总数据。 |
|
|
object |
|||
| FieldName |
string |
查询汇总指标值。 |
Traffic |
| DimensionName |
string |
查询汇总维度。 |
ALL |
| DimensionValue |
string |
查询汇总维度值。 |
ALL |
| AggMethod |
string |
汇总方法。 |
sum |
| Value |
any |
汇总数值。 |
12345 |
| RequestId |
string |
请求 ID。 |
04F0F334-1335-436C-A1D7-6C044FE7**** |
| StartTime |
string |
获取数据的起始时间。 日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-04-08T16:00:00Z |
| EndTime |
string |
获取数据的结束时间。 日期格式按照 ISO8601 表示法，并使用 UTC+0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2023-04-09T16:00:00Z |
| Interval |
integer |
数据粒度，单位：秒。 |
300 |
| SamplingRate |
number |
采样率，单位：%。 |
100 |
示例
正常返回示例
JSON格式
{
"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
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter.TimeRange | The specified time range exceeds the limit. Adjust it and try again. | 您配置的数据查询时间范围过长，请调整数据查询时间范围后重试。 |
| 400 | TooManyRequests | Too many requests.Please try again later. | 请求过于频繁，请稍后重试。 |
| 400 | InvalidEndTime.Mismatch | The specified EndTime is earlier than the StartTime. | 您填入的结束时间早于开始时间，请检查后重试。 |
| 400 | InvalidParameter | 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. | 您的套餐不含该功能，请升级套餐或联系商务添加。 |
| 400 | InvalidParameter.Field | The specified Field is invalid. | 您的查询指标有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。 |
| 400 | InvalidParameter.Dimension | The specified Dimension is invalid. | 您的查询维度有误，请仔细检查请求参数是否存在且合法，详细信息参见“OpenAPI文档”。 |
| 400 | InvalidTime.Malformed | Specified start time or end time is malformed. | 您指定的时间格式有误，时间需要符合yyyy-MM-ddTHH:mm:ssZ格式。请您正确输入后重试。 |
| 400 | TooManyDimensions | Too many query dimensions specified. Delete some and try again. | 您配置的数据查询维度过多，请您删除部分查询维度后重试。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。