当前内容仅提供英语版本,中文版我们将尽快补充,感谢您的理解。

DescribeTimingL7OriginPullData

1. API Description

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

This API is used to query time series data of origin-pull for L7 domains.
Group aggregation can be performed by specifying the query dimension DimensionName, returning multiple groups of time series data. For detailed guide and limits, see How to Use API to Implement Grouping Aggregation in a Single Call.

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.
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 API.
MetricNames.NYesArray of StringMetric list. Valid values:
  • l7Flow_outFlux_hy: Request traffic from the EdgeOne node to the origin server. Unit: Byte.
  • l7Flow_outBandwidth_hy: Request bandwidth from the EdgeOne node to the origin server. Unit: bps.
  • l7Flow_request_hy: Number of requests from the EdgeOne node to the origin server. Unit: count.
  • l7Flow_inFlux_hy: Response traffic from the origin server to the EdgeOne node. Unit: Byte.
  • l7Flow_inBandwidth_hy: Response bandwidth from the origin server to the EdgeOne node. Unit: bps.
StartTimeYesTimestamp ISO8601Start time.
EndTimeYesTimestamp ISO8601End time. The query time range (EndTime - StartTime) must be less than or equal to 31 days.
IntervalNoStringTime granularity of the query. Valid values:
  • min: 1 minute;
  • 5min: 5 minutes;
  • hour: 1 hour;
  • day: 1 day.
If this parameter is not specified, the granularity will be automatically inferred based on the time range between the start time and end time. Specifically, the granularity will be min, 5min, hour, and day when the time range is within 2 hours, within 2 days, within 7 days, and exceeding 7 days, respectively.
Filters.NNoArray of QueryConditionFilter criteria. Detailed filter criteria:
  • domain: The requested domain name from the client. If accessing EdgeOne via a wildcard domain, the data records the wildcard domain name rather than the specific subdomain.
  • originStatusCode: Origin status code. This filter is supported only when MetricNames = ["l7Flow_request_hy"].
    Valid values:
    • 1xx: Status codes in the 1xx range.
    • 2xx: Status codes in the 2xx range.
    • 3xx: Status codes in the 3xx range.
    • 4xx: Status codes in the 4xx range.
    • 5xx: Status codes in the 5xx range.
    • Any integer in the range [0, 600).
Note: When DimensionName is not empty, only the equals operator is supported.
DimensionNameNoStringQuery dimension name. Valid values:
  • domain: The domain name requested by the client. If EdgeOne is accessed via a wildcard domain name, the data records the wildcard domain name.
    When using the domain dimension, the Filters parameter must include the domain filter item, specifying a list of up to 100 domain names.
  • origin-status-code: Origin status code, such as 200 or 404.
    This dimension is supported only when MetricNames = ["l7Flow_request_hy"].
  • origin-status-code-category: Origin status code category, such as 2xx or 4xx.
    This dimension is supported only when MetricNames = ["l7Flow_request_hy"].

If DimensionName is left empty, data is aggregated by the AppId dimension by default, returning a single set of data.

If DimensionName is specified, time series data is returned grouped by the specified dimension. For example:

    When DimensionName = origin-status-code:
    • TimingDataRecords.TypeKey in the returned data is the specific origin status code, such as 200.
    • TimingDataRecords.TypeValue in the returned data is the time series data corresponding to that status code.

Note: When DimensionName is specified, concurrent calls are not allowed. Exceeding the query rate limit will return the error InvalidParameter.ActionInProgress.

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 Query All Site Layer-7 Origin-Pull Data

Query all domain names under ALL sites for the aggregated data of the l7Flow_outFlux_hy object during the period 2025-12-01T00:00:00Z to 2025-12-02T00:00:00Z.

Input Example

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

{
    "ZoneIds": [
        "*"
    ],
    "MetricNames": [
        "l7Flow_outFlux_hy"
    ],
    "StartTime": "2025-12-01T00:00:00Z",
    "EndTime": "2025-12-02T00:00:00Z"
}

Output Example

{
    "Response": {
        "TimingDataRecords": [
            {
                "TypeKey": "1300224863",
                "TypeValue": [
                    {
                        "Avg": 157,
                        "Detail": [
                            {
                                "Timestamp": 1764547200,
                                "Value": 0
                            }
                        ],
                        "Max": 4643,
                        "MetricName": "l7Flow_outFlux_hy",
                        "Sum": 45461
                    }
                ]
            }
        ],
        "TotalCount": 1,
        "RequestId": "853e9004-b4b0-4ae8-8a8f-510fe42f01e2"
    }
}

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
InvalidParameter.ActionInProgressToo many attempts. Please try again later.
InvalidParameterValue.FiltersMustIncludeDimensionNameWhen specifying the DimensionName parameter, the Filters field must contain filter criteria corresponding to DimensionName.
LimitExceeded.QueryTimeLimitExceededQuery time limit exceeded.
LimitExceeded.TimingDataItemLimitExceededThe time series data items queried this time exceed the limit.
OperationDenied.OriginPullDataNotSupportedThe current root account does not have permission for the data query interface. contact after-sales.