边缘安全加速平台 EO 查询流量分析Top数据

1. 接口描述

接口请求域名： teo.tencentcloudapi.com 。

本接口用于查询七层域名业务按照指定维度的 topN 数据。
注意：

本接口查询数据有 10 分钟左右延迟，建议拉取当前时间 10 分钟以前的数据。
本接口默认返回防护后的流量请求数据，用户可在 Filters.mitigatedByWebSecurity 中自定义查询已防护缓释的数据。

默认接口请求频率限制：100次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTopL7AnalysisData。
Version	是	String	公共参数，本接口取值：2022-09-01。
Region	否	String	公共参数，此参数为可选参数。
StartTime	是	Timestamp ISO8601	开始时间。
EndTime	是	Timestamp ISO8601	结束时间。查询时间范围（`EndTime` - `StartTime`）需小于等于 31 天。
MetricName	是	String	查询的指标，取值有： l7Flow_outFlux_country：按国家/地区维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_province：按中国大陆境内省份维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_statusCode：按状态码维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_domain：按域名维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_url：按 URL Path 维度统计 L7 EdgeOne 响应流量指标; l7Flow_outFlux_resourceType：按资源类型维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_sip：按客户端 IP 维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_referers：按 Referer 维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_ua_device：按设备类型维度统计 L7 EdgeOne 响应流量指标; l7Flow_outFlux_ua_browser：按浏览器类型维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_ua_os：按操作系统类型维度统计 L7 EdgeOne 响应流量指标； l7Flow_outFlux_ua：按 User-Agent 维度统计 L7 EdgeOne 响应流量指标； l7Flow_request_country：按国家/地区维度统计 L7 访问请求数指标； l7Flow_request_province：按中国大陆境内省份维度统计 L7 访问请求数指标； l7Flow_request_statusCode：按状态码维度统计 L7 访问请求数指标； l7Flow_request_domain：按域名维度统计 L7 访问请求数指标； l7Flow_request_url：按 URL Path 维度统计 L7 访问请求数指标; l7Flow_request_resourceType：按资源类型维度统计 L7 访问请求数指标； l7Flow_request_sip：按客户端 IP 维度统计 L7 访问请求数指标； l7Flow_request_referer：按 Referer 维度统计 L7 访问请求数指标； l7Flow_request_ua_device：按设备类型维度统计 L7 访问请求数指标; l7Flow_request_ua_browser：按浏览器类型维度统计 L7 访问请求数指标； l7Flow_request_ua_os：按操作系统类型维度统计 L7 访问请求数指标； l7Flow_request_ua：按 User-Agent 维度统计 L7 访问请求数指标。
ZoneIds.N	否	Array of String	站点 ID 集合，此参数将于2024年05月30日后由可选改为必填，详见公告：【腾讯云 EdgeOne】云 API 变更通知。最多传入 100 个站点 ID。若需查询腾讯云主账号下所有站点数据，请用 `*` 代替，查询账号级别数据需具备本接口全部站点资源权限。
Limit	否	Integer	查询前多少个 top 数据，最大值为1000。不填默认为10，表示查询 top10 的数据。
Filters.N	否	Array of QueryCondition	筛选数据时使用的过滤条件，取值参考指标分析筛选条件说明中针对 L7 访问流量、带宽、请求数的可用筛选项。如需限定站点或内容标识符，请在 `ZoneIds.N` 参数中另行传入对应的值。
Interval	否	String	查询时间粒度，该参数无效，待废弃。
Area	否	String	数据归属地区。该参数已废弃。请在 `Filters.country` 中按客户端地域过滤数据。

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询结果的总条数。
Data	Array of TopDataRecord	七层访问数据按照 MetricName 指定统计维度的前 topN 数据列表。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询特定 HTTP 协议版本下的 Top URL Path 流量数据

查询特定 HTTP 协议版本（HTTP/1.0、HTTP/1.1）下的 Top URL Path 流量数据。

输入示例

POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7AnalysisData
<公共请求参数>

{
    "Area": "mainland",
    "Interval": "day",
    "Limit": "1",
    "StartTime": "2022-07-31T00:00:00+08:00",
    "EndTime": "2022-08-29T19:17:59+08:00",
    "MetricName": "l7Flow_outFlux_url",
    "Filters": [
        {
            "Key": "protocol",
            "Operator": "equals",
            "Value": [
                "HTTP/1.0",
                "HTTP/1.1"
            ]
        }
    ],
    "ZoneIds": [
        "zone-2mzegj4vln5f"
    ]
}

输出示例

{
    "Response": {
        "RequestId": "7c499897-8ad9-4a2d-884e-6154f283d723",
        "Data": [
            {
                "DetailData": [
                    {
                        "Key": "path",
                        "Value": 1210001
                    }
                ],
                "TypeKey": "251227260"
            }
        ],
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.ProxyServer	后端服务器发生未知错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
LimitExceeded.QueryTimeLimitExceeded	查询时间范围超出限制。
OperationDenied	操作被拒绝。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.CamUnauthorized	Cam 未授权。
UnauthorizedOperation.NoPermission	子账户没有操作权限，请添加权限后继续操作。

查询流量分析Top数据

本页目录：