查询流量分析时序数据

最近更新时间:2025-01-06 01:26:50

我的收藏

1. 接口描述

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

本接口查询七层域名业务的时序数据。请注意本接口查询数据有 10 分钟左右延迟,建议拉取当前时间 10 分钟以前的数据。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTimingL7AnalysisData。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
StartTime Timestamp ISO8601 开始时间。
EndTime Timestamp ISO8601 结束时间。
MetricNames.N Array of String 指标列表,取值有:
  • l7Flow_outFlux: L7 EdgeOne 响应流量,单位:Byte;
  • l7Flow_inFlux: L7 客户端请求流量,单位:Byte;
  • l7Flow_flux: L7 访问总流量(EdgeOne 响应+客户端请求),单位:Byte;
  • l7Flow_outBandwidth: L7 EdgeOne 响应带宽,单位:bps;
  • l7Flow_inBandwidth:L7 客户端请求带宽,单位:bps;
  • l7Flow_bandwidth:L7 访问总带宽(EdgeOne 响应+客户端请求),单位:bps;
  • l7Flow_request: L7 访问请求数,单位:次;
  • l7Flow_avgResponseTime: L7 访问平均响应耗时,单位:ms;
  • l7Flow_avgFirstByteResponseTime: L7 访问平均首字节响应耗时,单位:ms。
  • ZoneIds.N Array of String 站点 ID 集合,此参数必填。
    Interval String 查询时间粒度,取值有:
  • min: 1分钟;
  • 5min: 5分钟;
  • hour: 1小时;
  • day: 1天。
  • 不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:2 小时范围内以 min 粒度查询,2 天范围内以 5min 粒度查询,7 天范围内以 hour 粒度查询,超过 7 天以 day 粒度查询。
    Filters.N Array of QueryCondition 过滤条件,详细的过滤条件 Key 值如下:
  • country:按照国家/地区进行过滤,国家/地区遵循 ISO 3166-1 alpha-2 规范。示例值:CN。
  • province:按照省份进行过滤,此参数只支持服务区域为中国大陆。省份代码参考境内省份映射表,示例值:22。
  • isp:按照运营商进行过滤,此参数只支持服务区域为中国大陆。对应的 Value 可选项如下:
       2:中国电信;
       26:中国联通;
       1046:中国移动;
       3947:中国铁通;
       38:教育网;
       43:长城宽带;
       0:其他运营商。
  • domain:按照子域名进行过滤,示例值: www.example.com。
  • url:按照 URL Path 进行过滤,示例值:/content 或 /content/test.jpg。若填写 url 参数,则最多可查询近 30 天的数据。
  • referer:按照 Referer 请求头部进行过滤,示例值:http://www.example.com/。若填写 referer 参数,则最多可查询近 30 天的数据;
  • resourceType:按照资源类型进行过滤,资源类型一般是文件后缀,示例值:.jpg。若填写 resourceType 参数,则最多可查询近 30 天的数据;
  • protocol:按照 HTTP 协议版本进行过滤。对应的 Value 可选项如下:
       HTTP/1.0;
       HTTP/1.1;
       HTTP/2.0;
       HTTP/3;
       WebSocket。
  • socket:按照 HTTP协议类型进行过滤。对应的 Value 可选项如下:
       HTTP:HTTP 协议;
       HTTPS:HTTPS 协议;
       QUIC:QUIC 协议。
  • statusCode:按照边缘状态码进行过滤。若填写 statusCode 参数,则最多可查询近 30 天的数据。对应的 Value 可选项如下:
       1XX:1xx类型的状态码;
       2XX:2xx类型的状态码;
       3XX:3xx类型的状态码;
       4XX:4xx类型的状态码;
       5XX:5xx类型的状态码;
       在 [0,600) 范围内的整数。
  • browserType:按照浏览器类型进行过滤。若填写 browserType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:
       Firefox:Firefox浏览器;
       Chrome:Chrome浏览器;
       Safari:Safari浏览器;
       Other:其他浏览器类型;
       Empty:浏览器类型为空;
       Bot:搜索引擎爬虫;
       MicrosoftEdge:MicrosoftEdge浏览器;
       IE:IE浏览器;
       Opera:Opera浏览器;
       QQBrowser:QQ浏览器;
       LBBrowser:LB浏览器;
       MaxthonBrowser:Maxthon浏览器;
       SouGouBrowser:搜狗浏览器;
       BIDUBrowser:百度浏览器;
       TaoBrowser:淘浏览器;
       UBrowser:UC浏览器。
  • deviceType:按照设备类型进行过滤。若填写 deviceType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:
       TV:TV设备;
       Tablet:Tablet设备;
       Mobile:Mobile设备;
       Desktop:Desktop设备;
       Other:其他设备类型;
       Empty:设备类型为空。
  • operatingSystemType:按照操作系统类型进行过滤。若填写 operatingSystemType 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:
       Linux:Linux操作系统;
       MacOS:MacOs操作系统;
       Android:Android操作系统;
       IOS:IOS操作系统;
       Windows:Windows操作系统;
       NetBSD:NetBSD;
       ChromiumOS:ChromiumOS;
       Bot:搜索引擎爬虫;
       Other:其他类型的操作系统;
       Empty:操作系统为空。
  • tlsVersion:按照 TLS 版本进行过滤。若填写 tlsVersion 参数,则最多可查询近 30 天的数据。对应 Value 的可选项如下:
       TLS1.0;
       TLS1.1;
       TLS1.2;
       TLS1.3。
  • ipVersion:按照 IP 版本进行过滤。对应 Value 的可选项如下:
       4:IPv4;
       6:IPv6。
  • cacheType:按照缓存状态进行过滤。对应 Value 的可选项如下:
       hit:请求命中 EdgeOne 节点缓存,资源由节点缓存提供。资源部分命中缓存也会记录为 hit。
       miss:请求未命中 EdgeOne 节点缓存,资源由源站提供。
       dynamic:请求的资源无法缓存/未配置被节点缓存,资源由源站提供。
       other:无法被识别的缓存状态。边缘函数响应的请求会记录为 other。
  • clientIp:按照客户端 IP 进行过滤。
  • Area String 数据归属地区,取值有:
  • overseas:全球(除中国大陆地区)数据;
  • mainland:中国大陆地区数据;
  • global:全球数据。

  • 不填默认取值为 global。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 查询结果的总条数。
    Data Array of TimingDataRecord 时序流量数据列表。
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 根据 HTTP 协议版本查询时序请求数数据

    根据 HTTP 协议版本筛选条件获取请求数指标数据。

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTimingL7AnalysisData
    <公共请求参数>
    
    {
        "EndTime": "2022-08-29T19:17:59+08:00",
        "Interval": "day",
        "Area": "mainland",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "MetricNames": [
            "l7Flow_request"
        ],
        "Filters": [
            {
                "Key": "protocol",
                "Operator": "equals",
                "Value": [
                    "HTTP/1.0",
                    "HTTP/1.1"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2o7b38ba1hvr"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 803,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1661731200,
                                    "Value": 0
                                }
                            ],
                            "Max": 7921,
                            "MetricName": "l7Flow_request",
                            "Sum": 24918
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

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