有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

本接口(DescribeOverviewL7Data)用于查询七层监控类时序流量数据。此接口待废弃,请使用 DescribeTimingL7AnalysisData 接口。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeOverviewL7Data。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
StartTime Timestamp ISO8601 开始时间。
EndTime Timestamp ISO8601 结束时间。
MetricNames.N Array of String 查询的指标,取值有:
  • l7Flow_outFlux: Edegone响应流量;
  • l7Flow_inFlux: Edgeone请求流量;
  • l7Flow_outBandwidth: Edegone响应带宽;
  • l7Flow_inBandwidth: Edegone请求带宽;
  • l7Flow_hit_outFlux: 缓存命中流量;
  • l7Flow_request: 访问请求数;
  • l7Flow_flux: 访问请求上行+下行流量;
  • l7Flow_bandwidth:访问请求上行+下行带宽。
  • ZoneIds.N Array of String 站点 ID 集合,此参数必填。
    Domains.N Array of String 查询的域名集合,此参数已经废弃。
    Protocol String 查询的协议类型,取值有:
  • http: http协议;
  • https: https协议;
  • http2: http2协议;
  • all: 所有协议。
  • 不填默认为all,此参数暂未生效。
    Interval String 查询时间粒度,取值有:
  • min:1分钟;
  • 5min:5分钟;
  • hour:1小时;
  • day:1天。
  • 不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:1小时范围内以min粒度查询,2天范围内以5min粒度查询,7天范围内以hour粒度查询,超过7天以day粒度查询。
    Filters.N Array of QueryCondition 过滤条件,详细的过滤条件Key值如下:
  • socket
       按照【HTTP协议类型】进行过滤。
       对应的Value可选项如下:
       HTTP:HTTP 协议;
       HTTPS:HTTPS协议;
       QUIC:QUIC协议。
  • domain
       按照【域名】进行过滤。
  • tagKey
       按照【标签Key】进行过滤。
  • tagValue
       按照【标签Value】进行过滤。
  • Area String 数据归属地区,取值有:
  • overseas:全球(除中国大陆地区)数据;
  • mainland:中国大陆地区数据;
  • global:全球数据。
  • 不填默认取值为global。

    3. 输出参数

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

    4. 示例

    示例1 根据标签查询时序流量数据

    根据标签的筛选条件获取请求数指标

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeOverviewL7Data
    <公共请求参数>
    
    {
        "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": "tagKey",
                "Operator": "equals",
                "Value": [
                    "test1"
                ]
            },
            {
                "Key": "tagValue",
                "Operator": "equals",
                "Value": [
                    "a.com",
                    "b.com"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "6cc74d08-c174-413a-976b-abe7b851e0121",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 1564,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 100
                                },
                                {
                                    "Timestamp": 1659225600,
                                    "Value": 34
                                }
                            ],
                            "Max": 8037,
                            "MetricName": "l7Flow_request",
                            "Sum": 48511
                        }
                    ]
                }
            ],
            "TotalCount": 1
        }
    }

    示例2 查询七层监控类时序流量数据

    查询七层监控数据的请求数指标

    输入示例

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

    输出示例

    {
        "Response": {
            "RequestId": "6cc74d08-c174-413a-976b-abe7b851e010",
            "Data": [
                {
                    "TypeKey": "251227260",
                    "TypeValue": [
                        {
                            "Avg": 1564,
                            "Detail": [
                                {
                                    "Timestamp": 1659139200,
                                    "Value": 0
                                },
                                {
                                    "Timestamp": 1659225600,
                                    "Value": 0
                                }
                            ],
                            "Max": 8037,
                            "MetricName": "l7Flow_request",
                            "Sum": 48511
                        }
                    ]
                }
            ],
            "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.RouteError 后端服务路由地址错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    LimitExceeded.QueryTimeLimitExceeded 查询时间范围超出限制。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。