tencent cloud

边缘安全加速平台 EO

文档边缘安全加速平台 EOAPI 文档Data Analysis APIsDescribeTimingL7OriginPullData

DescribeTimingL7OriginPullData

PDF
聚焦模式
字号
最后更新时间： 2026-04-13 14:46:15

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 Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTimingL7OriginPullData.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneIds.N Yes Array of String Site 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.N Yes Array of String Metric list. valid values:
  • l7Flow_outFlux_hy: specifies the request traffic from the EdgeOne node to the origin server direction. measurement unit: Byte.
  • l7Flow_outBandwidth_hy: request bandwidth from EdgeOne node to origin server direction, measurement unit: bps;
    • .
  • l7Flow_request_hy: number of requests in the EdgeOne node to origin server direction. unit: count.
    • .
  • l7Flow_inFlux_hy: specifies the response traffic from the origin server to the EdgeOne node direction, measurement unit: Byte.
    • .
  • l7Flow_inBandwidth_hy: specifies the response bandwidth from the origin server to the EdgeOne node. measurement unit: bps.
.
StartTime Yes Timestamp ISO8601 Start time.
EndTime Yes Timestamp ISO8601 End time. The query time range (EndTime - StartTime) must be less than or equal to 31 days.
Interval No String Time 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 inferred 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 within 2 hours, within 2 days, within 7 days, and exceeding 7 days.
Filters.N No Array of QueryCondition Filter criteria. detailed filter criteria:.
  • domain: the requested domain name from the client. if accessing EdgeOne via wildcard domain, the data records the wildcard domain name rather than the specific domain.
  • originStatusCode: origin status code. this filter item is supported only when MetricNames = ["l7Flow_request_hy"].
    the corresponding Value options are as follows:
    • 1xx: status codes of the 1xx kind.
    • 2xx: status codes of the 2xx kind.
    • 3xx: status codes of the 3xx kind.
    • 4xx: status codes of the 4xx kind.
    • 5xx: status codes of the 5xx kind.
    • integer within range [0, 600) (excluding 600).
.
Note: when DimensionName is not empty, only the equals operator is supported.
DimensionName No String

Query 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 must include the domain filter item, specifying a list of no more than 100 domain names to query.
  • origin-status-code: origin status code, such as 200, 404.
    this dimension is supported only when MetricNames = ["l7Flow_request_hy"].
  • origin-status-code-category: origin status code category, such as 2xx, 4xx.
    this dimension is supported only when MetricNames =["l7Flow_request_hy"].

if the DimensionName input parameter is empty, the data is aggregated by the AppId dimension by default, returning only one set of data.

if the DimensionName input parameter is not empty, the corresponding time series data is returned grouped by the specified query dimension. for example:

    when DimensionName = origin-status-code:
    • the TimingDataRecords.TypeKey in the returned data is the specific origin status code, such as 200.
    • the TimingDataRecords.TypeValue in the returned data is the time series data corresponding to that status code.
.
Note: when specifying DimensionName during queries, concurrent calls are forbidden. if exceeded the query frequency limit, it will return an error InvalidParameter.ActionInProgress.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of entries in the query result.
TimingDataRecords Array of TimingDataRecord Time series data list for origin-pull data.
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 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 Code Description
InvalidParameter.ActionInProgress Too many attempts. Please try again later.
InvalidParameterValue.FiltersMustIncludeDimensionName When specifying the DimensionName parameter, the Filters field must contain filter criteria corresponding to DimensionName.
LimitExceeded.QueryTimeLimitExceeded Query time limit exceeded.
LimitExceeded.TimingDataItemLimitExceeded The time series data items queried this time exceed the limit.
OperationDenied.OriginPullDataNotSupported The current root account does not have permission for the data query interface. contact after-sales.
上一篇: DescribeOverviewL7Data下一篇: DescribeTimingL4Data

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈