查询账户维度或站点维度流量分析Top数据。
接口说明
-
如果您不指定 StartTime 和 EndTime，该接口返回过去 24 小时的数据；指定 StartTime 和 EndTime，该接口返回指定时间段的数据。
-
由于查询时间段的访问次数较多，数据分析可能经过采样。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| esa:DescribeSiteTopData | none | *Site acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 否 | 查询数据的时间粒度，单位为秒。 | 300 |
| Fields | array<object> | 是 | 查询指标。 | |
| object | 是 | 查询指标。 | ||
| FieldName | string | 否 | 查询指标值。 说明
具体维度请参见数据分析字段说明。
| Traffic |
| Dimension | array | 否 | 查询维度。 | |
| string | 否 | 查询维度。 说明
具体维度请参见数据分析字段说明。
| ALL | |
| Limit | string | 否 | 查询 Top 数据个数。 枚举值：
| 5 |
返回参数
示例
正常返回示例
JSON格式
{
"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
}错误码
| 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. | 您配置的数据查询维度过多，请您删除部分查询维度后重试。 |
访问错误中心查看更多错误码。