Docs Overview/
DescribeTimingL7OriginPullData/

DescribeTimingL7OriginPullData

1. API Description

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

This API is used to query time series data for layer-7 domain services' origin-pull data.

A maximum of 20 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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeTimingL7OriginPullData.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
StartTimeYesTimestamp ISO8601Start time.
EndTimeYesTimestamp ISO8601End time. The query time range (EndTime - StartTime) must be less than or equal to 31 days.
MetricNames.NYesArray of StringMetric list. Valid values:.
  • l7Flow_outFlux_hy: specifies the request traffic from the EdgeOne node to the origin server. Unit: byte.
  • l7Flow_outBandwidth_hy: specifies the request bandwidth from EdgeOne node to origin server. Unit: bps.
  • l7Flow_request_hy: specifies the request count from EdgeOne node to origin server. Unit: times.
  • l7Flow_inFlux_hy: specifies the response traffic from the origin server to the EdgeOne node. Unit: byte.
  • l7Flow_inBandwidth_hy: specifies the response bandwidth from the origin server to the EdgeOne node. Unit: bps.

    • ZoneIds.NYesArray of StringSite ID set. This parameter is required. A maximum of 100 zone-ids can be imported. Use * to query data for all sites under the Tencent Cloud root account. Querying account-level data requires permissions for all site resources in this interface.
    IntervalNoStringTime granularity of the query. Valid values:
  • min: 1 minute.
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
    • If this parameter is not input, 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.NNoArray of QueryConditionFilter conditions. Details:
  • domain: specifies the domain name in client requests. When the domain is onboarded via a wildcard, the recorded value is the wildcard domain itself, not the specific subdomain.

    • 3. Output Parameters

    Parameter NameTypeDescription
    TotalCountIntegerTotal number of entries in the query result.
    TimingDataRecordsArray of TimingDataRecordTime series data list for origin-pull data.
    RequestIdStringThe 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 Time Series Data for Origin Analysis

    This example shows you how to query the number of origin-pull requests for layer-7 domain services under specified site ID zone-2ntf1u8utpmz from 2025-07-01 00:00:00 to 2025-07-15 00:00:00 with a query time granularity of day.

    Input Example

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

{
    "StartTime": "2025-07-01T00:00:00+08:00",
    "EndTime": "2025-07-15T00:00:00+08:00",
    "Interval": "day",
    "MetricNames": [
        "l7Flow_request_hy"
    ],
    "ZoneIds": [
        "zone-2ntf1u8utpmz"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "7cc73e86-092b-4aa2-b28a-c9c338834926",
        "TimingDataRecords": [
            {
                "TypeKey": "251008840",
                "TypeValue": [
                    {
                        "Avg": 1714316,
                        "Detail": [
                            {
                                "Timestamp": 1751299200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1751385600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1751472000,
                                "Value": 1471972
                            },
                            {
                                "Timestamp": 1751558400,
                                "Value": 2824464
                            },
                            {
                                "Timestamp": 1751644800,
                                "Value": 2815290
                            },
                            {
                                "Timestamp": 1751731200,
                                "Value": 2814852
                            },
                            {
                                "Timestamp": 1751817600,
                                "Value": 2815244
                            },
                            {
                                "Timestamp": 1751904000,
                                "Value": 11147558
                            },
                            {
                                "Timestamp": 1751990400,
                                "Value": 6
                            },
                            {
                                "Timestamp": 1752076800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1752163200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1752249600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1752336000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1752422400,
                                "Value": 111050
                            }
                        ],
                        "Max": 11147558,
                        "MetricName": "l7Flow_request_hy",
                        "Sum": 24000436
                    }
                ]
            }
        ],
        "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 CodeDescription
    LimitExceeded.QueryTimeLimitExceededQuery time limit exceeded.
    OperationDenied.OriginPullDataNotSupportedThe current root account does not have permission for the data query interface. contact after-sales.