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

1. 接口描述

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

本接口(DescribeTopL7CacheData)用于查询七层缓存分析topN流量数据。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTopL7CacheData。
Version String 公共参数,本接口取值:2022-09-01。
Region String 公共参数,此参数为可选参数。
StartTime Timestamp ISO8601 开始时间。
EndTime Timestamp ISO8601 结束时间。
MetricName String 查询的指标,取值有:
  • l7Cache_outFlux_domain:host/域名;
  • l7Cache_outFlux_url:url地址;
  • l7Cache_outFlux_resourceType:资源类型;
  • l7Cache_outFlux_statusCode:状态码。
  • ZoneIds.N Array of String 站点 ID 集合,此参数必填。
    Limit Integer 查询前多少个数据,最大值为1000,不填默认为10, 表示查询前top 10的数据。
    Filters.N Array of QueryCondition 过滤条件,详细的过滤条件如下:
  • domain
       按照【子域名】进行过滤,子域名形如: test.example.com。
       类型:String
       必选:否
  • url
       按照【URL】进行过滤,此参数只支持30天的时间范围,URL形如:/content。
       类型:String
       必选:否
  • resourceType
       按照【资源类型】进行过滤,此参数只支持30天的时间范围,资源类型形如:jpg,png。
       类型:String
       必选:否
  • cacheType
       按照【缓存类型】进行过滤。
       类型:String
       必选:否
       可选项:
       hit:命中缓存;
       dynamic:资源不可缓存;
       miss:未命中缓存。
  • statusCode
       按照【状态码】进行过滤,此参数只支持30天的时间范围。
       类型:String
       必选:否
       可选项:
       1XX:1xx类型的状态码;
       100:100状态码;
       101:101状态码;
       102:102状态码;
       2XX:2xx类型的状态码;
       200:200状态码;
       201:201状态码;
       202:202状态码;
       203:203状态码;
       204:204状态码;
       100:100状态码;
       206:206状态码;
       207:207状态码;
       3XX:3xx类型的状态码;
       300:300状态码;
       301:301状态码;
       302:302状态码;
       303:303状态码;
       304:304状态码;
       305:305状态码;
       307:307状态码;
       4XX:4xx类型的状态码;
       400:400状态码;
       401:401状态码;
       402:402状态码;
       403:403状态码;
       404:404状态码;
       405:405状态码;
       406:406状态码;
       407:407状态码;
       408:408状态码;
       409:409状态码;
       410:410状态码;
       411:411状态码;
       412:412状态码;
       412:413状态码;
       414:414状态码;
       415:415状态码;
       416:416状态码;
       417:417状态码;
       422:422状态码;
       423:423状态码;
       424:424状态码;
       426:426状态码;
       451:451状态码;
       5XX:5xx类型的状态码;
       500:500状态码;
       501:501状态码;
       502:502状态码;
       503:503状态码;
       504:504状态码;
       505:505状态码;
       506:506状态码;
       507:507状态码;
       510:510状态码;
       514:514状态码;
       544:544状态码。
  • tagKey
       按照【标签Key】进行过滤。
       类型:String
       必选:否
  • tagValue
       按照【标签Value】进行过滤。
       类型:String
       必选:否
  • Interval String 查询时间粒度,取值有:
  • min: 1分钟;
  • 5min: 5分钟;
  • hour: 1小时;
  • day: 1天。
  • 不填将根据开始时间跟结束时间的间距自动推算粒度,具体为:一小时范围内以min粒度查询,两天范围内以5min粒度查询,七天范围内以hour粒度查询,超过七天以day粒度查询。
    Area String 数据归属地区,取值有:
  • overseas:全球(除中国大陆地区)数据;
  • mainland:中国大陆地区数据;
  • global:全球数据。
  • 不填默认取值为global。

    3. 输出参数

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

    4. 示例

    示例1 根据指定标签的top流量数据

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTopL7CacheData
    <公共请求参数>
    
    {
        "Area": "mainland",
        "Interval": "day",
        "Limit": "5",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "EndTime": "2022-08-29T19:17:59+08:00",
        "MetricName": "l7Cache_outFlux_cacheType",
        "Filters": [
            {
                "Key": "tagKey",
                "Operator": "equals",
                "Value": [
                    "test1"
                ]
            },
            {
                "Key": "tagValue",
                "Operator": "equals",
                "Value": [
                    "a.com",
                    "b.com"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "64463c6f-3296-47fa-b168-2040f841eed1",
            "Data": [
                {
                    "DetailData": [
                        {
                            "Key": "hit",
                            "Value": 5810001
                        },
                        {
                            "Key": "miss",
                            "Value": 658
                        }
                    ],
                    "TypeKey": "251227260"
                }
            ],
            "TotalCount": 1
        }
    }

    示例2 查询指定状态码的top流量数据

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTopL7CacheData
    <公共请求参数>
    
    {
        "Area": "mainland",
        "Interval": "day",
        "Limit": "5",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "EndTime": "2022-08-29T19:17:59+08:00",
        "MetricName": "l7Cache_outFlux_cacheType",
        "Filters": [
            {
                "Key": "statusCode",
                "Operator": "equals",
                "Value": [
                    "2XX",
                    "3XX"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "64463c6f-3296-47fa-b168-2040f841eed1",
            "Data": [
                {
                    "DetailData": [
                        {
                            "Key": "hit",
                            "Value": 5810001
                        },
                        {
                            "Key": "miss",
                            "Value": 658
                        }
                    ],
                    "TypeKey": "251227260"
                }
            ],
            "TotalCount": 1
        }
    }

    示例3 查询七层缓存分析类top流量数据

    输入示例

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

    输出示例

    {
        "Response": {
            "RequestId": "64463c6f-4c96-47fa-b168-2040f841eed1",
            "Data": [
                {
                    "DetailData": [
                        {
                            "Key": "hit",
                            "Value": 7410001
                        },
                        {
                            "Key": "miss",
                            "Value": 803
                        }
                    ],
                    "TypeKey": "251227260"
                }
            ],
            "TotalCount": 1
        }
    }

    示例4 查询缓存命中跟未命中的top流量数据

    输入示例

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeTopL7CacheData
    <公共请求参数>
    
    {
        "Area": "mainland",
        "Interval": "day",
        "Limit": "5",
        "StartTime": "2022-07-31T00:00:00+08:00",
        "EndTime": "2022-08-29T19:17:59+08:00",
        "MetricName": "l7Cache_outFlux_cacheType",
        "Filters": [
            {
                "Key": "cacheType",
                "Operator": "equals",
                "Value": [
                    "miss",
                    "hit"
                ]
            }
        ],
        "ZoneIds": [
            "zone-2mzegj4vln5f"
        ]
    }

    输出示例

    {
        "Response": {
            "RequestId": "64463c6f-3296-47fa-b168-2040f841eed1",
            "Data": [
                {
                    "DetailData": [
                        {
                            "Key": "hit",
                            "Value": 7410001
                        },
                        {
                            "Key": "miss",
                            "Value": 803
                        }
                    ],
                    "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。

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    LimitExceeded.QueryTimeLimitExceeded 查询时间范围超出限制。
    ResourceUnavailable 资源不可用。
    UnauthorizedOperation.CamUnauthorized Cam 未授权。