tencent cloud

All product documents
Tencent Cloud EdgeOne
DocumentationTencent Cloud EdgeOneAPI DocumentationData Analysis APIsDescribeTimingL7AnalysisData
DescribeTimingL7AnalysisData
Download PDF
Last updated: 2025-04-21 19:40:32
DescribeTimingL7AnalysisData
Last updated: 2025-04-21 19:40:32
Download PDF

1. API Description

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

This API is used to query the time series data of the L7 domain name. Note that there is a delay of about 10 minutes for this API. It is recommended to pull data from 10 minutes before the current time.

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: DescribeTimingL7AnalysisData.
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.
MetricNames.N Yes Array of String Metric list. Valid values:.
  • l7Flow_outFlux: L7 EdgeOne response traffic. Unit: byte;

  • l7Flow_inFlux: L7 client request traffic. Unit: byte;

  • l7Flow_flux: L7 total traffic (including EdgeOne response traffic and client request traffic). Unit: byte;

  • l7Flow_outBandwidth: L7 EdgeOne response bandwidth. Unit: bps;

  • l7Flow_inBandwidth: L7 client request bandwidth. Unit: bps;

  • l7Flow_bandwidth: L7 total bandwidth (including EdgeOne response bandwidth and client request bandwidth). Unit: bps;

  • l7Flow_request: L7 request count. Unit: times;

  • l7Flow_avgResponseTime: Average L7 edge response time. Unit: ms (milliseconds);

  • l7Flow_avgFirstByteResponseTime: Average L7 edge first byte response time. Unit: ms.
    		•
    ZoneIds.N No Array of String Zone ID set. This parameter is required.
    Interval No String Query period granularity. Valid values:
  • min: 1 minute;
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
    • If this parameter is not filled in, the granularity will be automatically calculated based on the interval between the start time and end time. Specifically, data will be queried with a granularity of min, 5min, hour, and day respectively when the period is no more than 2 hours, no more than 2 days, no more than 7 days, and over 7 days.
    Filters.N No Array of QueryCondition Filter criteria. The detailed key values of filter criteria are as follows:
  • country: filter by country/region. The country/region follows the ISO 3166-1 alpha-2 standard. Example value: CN.
  • province: filter by province. This parameter is supported only when the service area is the chinese mainland. refer to the mapping table of provinces within the chinese mainland for province codes. Example value: 22.
  • isp: filter by isp. This parameter only supports the service area of chinese mainland. The corresponding value options are as follows:
    2: china telecom;
    26: china unicom;
    1046: cmcc;
    3947: china tietong;
    38: china education network;
    43: great wall broadband;
    0: other isp.

  • domain: filter by subdomain. Example value: www.example.com.
  • url: filter by url Path. Example value: /content or /content/test.jpg. If you fill in url parameters, you can query the data of the last 30 days at most.

  • referer: filter by referer request header. Example value: http://www.example.com/. If the referer parameter is provided, up to 30 days of data can be queried.
  • resourceType: filter by resource type. The resource type is generally a file suffix. Example value: .jpg. If the resourceType parameter is provided, data from the last 30 days can be queried at most;
  • protocol: filter by HTTP protocol version. The corresponding value options are as follows:
    HTTP/1.0;
    HTTP/1.1;
    HTTP/2.0;
    HTTP/3;
    WebSocket.
  • socket: filter by HTTP protocol type. The corresponding value options are as follows:
    HTTP: hypertext transfer protocol;
    HTTPS: HTTPS protocol;
    QUIC: QUIC protocol.
  • statusCode: filter by edge status code. If the statusCode parameter is filled in, data from the last 30 days can be queried at most. The corresponding value options are as follows:
    1XX: 1XX type status codes;
    2XX: 2XX type status codes;
    3XX: 3XX type status codes;
    4XX: 4XX type status codes;
    5XX: 5XX type status codes;
    integers within the range [0,600).
  • browserType: filter by browser type. If the browserType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value are as follows:
    Firefox: Firefox browser;
    Chrome: Chrome browser;
    Safari: Safari browser;
    Other: Other browser types;
    Empty: browser type is Empty;
    Bot: search engine crawler;
    MicrosoftEdge: microsoft edge browser;
    IE: IE browser;
    Opera: Opera browser;
    QQBrowser: QQ browser;
    LBBrowser: LB browser;
    MaxthonBrowser: Maxthon browser;
    SouGouBrowser: sogou browser;
    BIDUBrowser: BIDUBrowser;
    TaoBrowser: TaoBrowser;
    UBrowser: UC browser.
  • deviceType: filter by device type. If the deviceType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value are as follows:
    TV: TV device;
    Tablet: Tablet device;
    Mobile: Mobile device;
    Desktop: Desktop device;
    Other: Other device type;
    Empty: device type Empty.
  • operatingSystemType: filter by operating system type. If the operatingSystemType parameter is filled in, data from the last 30 days can be queried at most. The options for The corresponding value are as follows:
    Linux: Linux operating system;
    MacOS: MacOS operating system;
    Android: Android operating system;
    IOS: IOS operating system;
    Windows: Windows operating system;
    NetBSD: NetBSD;
    ChromiumOS: ChromiumOS;
    Bot: Bot: search engine crawler;
    Other: Other types of operating systems;
    Empty: operating system is Empty.
  • tlsVersion: filter by TLS version. If the tlsVersion parameter is input, data from the last 30 days can be queried at most. The options for The corresponding value are as follows:
    TLS1.0;
    TLS1.1;
    TLS1.2;
    TLS1.3.
  • ipVersion: filter by IP version. The options for the corresponding value are as follows:
    4: IPv4;
    6: IPv6.
  • cacheType: filter by cache status. The options for The corresponding value are as follows:
    hit: request hits EdgeOne node cache, and resources are provided by node cache. partial cache hit for resources is also recorded as hit.
    miss: request does not hit EdgeOne node cache, and resources are provided by the origin server.
    dynamic: requested resources cannot be cached/unconfigured to be cached by node cache, and resources are provided by the origin server.
    other: unrecognizable cache status. requests responded to by edge functions are recorded as other.
  • clientIp: filter by client IP. If the clientIp parameter is filled in, data from the last 30 days can be queried at most.
  • userAgent: filter by User-Agent request header. If the userAgent parameter is filled in, data from the last 30 days can be queried at most.

    		•
    Area No String Data ownership region. This parameter is deprecated. Please filter data by client region in Filters.country.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of query results.
    Data Array of TimingDataRecord The list of L7 traffic data recorded over time.
    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 Querying the Time Series Data of the Request Count by HTTP Protocol Version

    This example shows you how to query the request count metric data by HTTP protocol version.

    Input Example

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

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

    Output Example

    {
    "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. 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.
    InternalError.ProxyServer An unknown error occurred in the backend server.
    InvalidParameter Parameter error.
    InvalidParameterValue Invalid parameter value.
    LimitExceeded The quota limit has been reached.
    LimitExceeded.QueryTimeLimitExceeded Query time limit exceeded.
    OperationDenied Operation denied.
    ResourceNotFound The resource doesn’t exist.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

    Submit a Ticket
    7x24 Phone Support