tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTopL7CacheData

Last updated: 2024-10-11 15:52:30

    1. API Description

    Domain name for API request: teo.tencentcloudapi.com.

    This API is used to query the cached L7 top-ranked data.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeTopL7CacheData.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    StartTime Yes Timestamp ISO8601 The start time.
    EndTime Yes Timestamp ISO8601 The end time.
    MetricName Yes String The query metric. Values:
  • l7Cache_outFlux_domain: Host/Domain name;
  • l7Cache_outFlux_url: URL address;
  • l7Cache_outFlux_resourceType: Resource type;
  • l7Cache_outFlux_statusCode: Status code.
    		•
    ZoneIds.N No Array of String ZoneId set. This parameter is required.
    Limit No Integer The number of data entries to be queried. The maximum value is 1000. If it is not specified, the value 10 is used by default, indicating that the top 10 data entries.
    Filters.N No Array of QueryCondition Filter conditions. See below for details:
  • domain
       Filter by the sub-domain name, such as test.example.com
       Type: String
       Required: No
  • url
       Filter by the URL, such as /content. The query period cannot exceed 30 days.
       Type: String
       Required: No
  • resourceType
       Filter by the resource file type, such as jpg, png. The query period cannot exceed 30 days.
      Type: String
       Required: No
  • cacheType
      Filter by the cache hit result.
     Type: String
       Required: No
       Values:
       hit: Cache hit;
       dynamic: Resource non-cacheable;
       miss: Cache miss
  • statusCode
       Filter by the status code. The query period cannot exceed 30 days.
       Type: String
       Required: No
       Values:
       1XX: All 1xx status codes;
       100: 100 status code;
       101: 101 status code;
       102: 102 status code;
       2XX: All 2xx status codes;
       200: 200 status code;
       201: 201 status code;
       202: 202 status code;
       203: 203 status code;
       204: 204 status code;
       205: 205 status code;
       206: 206 status code;
       207: 207 status code;
       3XX: All 3xx status codes;
       300: 300 status code;
       301: 301 status code;
       302: 302 status code;
       303: 303 status code;
       304: 304 status code;
       305: 305 status code;
       307: 307 status code;
       4XX: All 4xx status codes;
       400: 400 status code;
       401: 401 status code;
       402: 402 status code;
       403: 403 status code;
       404: 404 status code;
       405: 405 status code;
       406: 406 status code;
       407: 407 status code;
       408: 408 status code;
       409: 409 status code;
       410: 410 status code;
       411: 411 status code;
       412: 412 status code;
       412: 413 status code;
       414: 414 status code;
       415: 415 status code;
       416: 416 status code;
       417: 417 status code;
      422: 422 status code;
       423: 423 status code;
       424: 424 status code;
       426: 426 status code;
       451: 451 status code;
       5XX: All 5xx status codes;
       500: 500 status code;
       501: 501 status code;
       502: 502 status code;
       503: 503 status code;
       504: 504 status code;
       505: 505 status code;
       506: 506 status code;
       507: 507 status code;
       510: 510 status code;
       514: 514 status code;
       544: 544 status code.
  • tagKey:
       Filter by the tag key
       Type: String
       Required: No
  • tagValue
       Filter by the tag value
       Type: String
       Required: No
    		•
    Interval No String The query time granularity. Values:
  • min: 1 minute;
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
    • If this field is not specified, the granularity will be determined based on the interval between the start time and end time as follows: 1-minute granularity applies for a 1-hour interval, 5-minute granularity for a 2-day interval, 1-hour granularity for a 7-day interval, and 1-day granularity for an interval of over 7 days.
    Area No String Geolocation scope. Values:
  • overseas: Regions outside the Chinese mainland
  • mainland: Chinese mainland
  • global: Global
    • If this field is not specified, the default value global is used.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of query results.
    Data Array of TopDataRecord The list of cached L7 top-ranked traffic data.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Top Traffic Data with the Specified Tag

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData
<Common request parameters>

{
    "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"
    ]
}

    Output Example

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

    Example2 Querying Top Traffic Data with the Specified Status Code

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData
<Common request parameters>

{
    "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"
    ]
}

    Output Example

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

    Example3 Querying L7 Cache Analysis Top Traffic Data

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData
<Common request parameters>

{
    "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"
    ]
}

    Output Example

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

    Example4 Querying Top Traffic Data of Cache Hit and Cache Miss

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTopL7CacheData
<Common request parameters>

{
    "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"
    ]
}

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    LimitExceeded.QueryTimeLimitExceeded Query time limit exceeded.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy