tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTimingL7SourceData

Last updated: 2023-05-25 17:35:57
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query the L7 time-series data of origin-pull.

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: DescribeTimingL7SourceData.
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 Start time of the query period.
EndTime Yes Timestamp ISO8601 End time of the query period.
MetricNames.N Yes Array of String List of metrics. Values:
  • l7Flow_outFlux_hy: EdgeOne request traffic
  • l7Flow_outBandwidth_hy: EdgeOne request bandwidth
  • l7Flow_inFlux_hy: Origin response traffic
  • l7Flow_inBandwidth_hy: Origin response bandwidth
  • l7Flow_request_hy: Origin-pull requests
    		•
    ZoneIds.N No Array of String List of sites to be queried. All sites will be selected if this field is not specified.
    Interval No String The query granularity. Values:
  • min: 1 minute
  • 5min: 5 minutes
  • hour: 1 hour
  • day: 1 day
    • If this field is not specified, the granularity is determined based on the query period. Query period < 1 hour**: 1-minute granularity; **1 hour < query period < 2 days**: 5-minute granularity; **2 days < query period < 7 days**: 1 hour granularity; **Query period > 7 days: 1 day granularity.
    Filters.N No Array of QueryCondition Filter conditions. See below for details:
  • domain:
       Filter by the origin domain
       Type: String
       Required: No
  • origin:
       Filter by the origin
       Type: String
       Required: No
  • originGroup:
       Filter by the origin group, such as origin-xxxxx.
       Type: String
       Required: No
  • flowType:
       Filter by the origin response type. This parameter takes precedence over MetricNames.N.
       Type: String
       Required: No
       Values:
       inFlow: Origin response data, corresponding to l7Flow_inFlux_hy, l7Flow_inBandwidth_hy and l7Flow_request_hy in MetricNames.N.
       outFlow: EdgeOne request data, corresponding to l7Flow_outFlux_hy, l7Flow_outBandwidth_hy and l7Flow_request_hy in MetricNames.N.
    		•
    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.
    TimingDataRecords Array of TimingDataRecord List of time series traffic data.
    Note: This field may return null, indicating that no valid value can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the origin-pull analysis data by a specified origin

    Input Example

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

{
    "StartTime": "2022-12-14T07:32:00+08:00",
    "EndTime": "2022-12-21T00:00:00+08:00",
    "ZoneIds": [
        "zone-2cfc5kesov7g"
    ],
    "Filters": [
        {
            "Key": "origin",
            "Operator": "equals",
            "Value": [
                "119.28.108.213"
            ]
        }
    ],
    "Interval": "hour",
    "Area": "overseas",
    "MetricNames": [
        "l7Flow_outFlux_hy",
        "l7Flow_inFlux_hy",
        "l7Flow_request_hy",
        "l7Flow_outBandwidth_hy",
        "l7Flow_inBandwidth_hy"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "02c49505-c740-4ee8-8128-dbe3ce0bf34e",
        "TimingDataRecords": [
            {
                "TypeKey": "251231751_cheney_test1",
                "TypeValue": [
                    {
                        "Avg": 2,
                        "Detail": [
                            {
                                "Timestamp": 1672002000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672005600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672009200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672092000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672095600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672099200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672102800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672106400,
                                "Value": 306
                            },
                            {
                                "Timestamp": 1672110000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672113600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672117200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672120800,
                                "Value": 307
                            },
                            {
                                "Timestamp": 1672124400,
                                "Value": 239
                            },
                            {
                                "Timestamp": 1672128000,
                                "Value": 0
                            }
                        ],
                        "Max": 25812,
                        "MetricName": "l7Flow_outFlux_hy",
                        "Sum": 26973
                    },
                    {
                        "Avg": 0,
                        "Detail": [
                            {
                                "Timestamp": 1671980400,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671984000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671987600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671991200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671994800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671998400,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672002000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672005600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672009200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672012800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672016400,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672128000,
                                "Value": 0
                            }
                        ],
                        "Max": 394,
                        "MetricName": "l7Flow_inBandwidth_hy",
                        "Sum": 418
                    }
                ]
            }
        ],
        "TotalCount": 1
    }
}

    Example2 Querying the time-series origin-pull data of a specified origin group

    Input Example

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

{
    "StartTime": "2022-12-21T00:00:00+08:00",
    "EndTime": "2022-12-27T16:28:00+08:00",
    "ZoneIds": [
        "zone-2cfc5kesov7g"
    ],
    "Filters": [
        {
            "Key": "originGroup",
            "Operator": "equals",
            "Value": [
                "origin-2be4c888-82a1-11ed-b61e-525400931057"
            ]
        }
    ],
    "Interval": "hour",
    "Area": "overseas",
    "MetricNames": [
        "l7Flow_outFlux_hy",
        "l7Flow_inFlux_hy",
        "l7Flow_request_hy",
        "l7Flow_outBandwidth_hy",
        "l7Flow_inBandwidth_hy"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "cfc96e9b-99bd-4800-8335-d195346c0218",
        "TimingDataRecords": [
            {
                "TypeKey": "251231751_cheney_test1",
                "TypeValue": [
                    {
                        "Avg": 2,
                        "Detail": [
                            {
                                "Timestamp": 1672117200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672120800,
                                "Value": 8
                            },
                            {
                                "Timestamp": 1672124400,
                                "Value": 6
                            },
                            {
                                "Timestamp": 1672128000,
                                "Value": 0
                            }
                        ],
                        "Max": 346,
                        "MetricName": "l7Flow_outBandwidth_hy",
                        "Sum": 376
                    },
                    {
                        "Avg": 179,
                        "Detail": [
                            {
                                "Timestamp": 1671796800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671800400,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671804000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672128000,
                                "Value": 0
                            }
                        ],
                        "Max": 27817,
                        "MetricName": "l7Flow_inFlux_hy",
                        "Sum": 28834
                    },
                    {
                        "Avg": 167,
                        "Detail": [
                            {
                                "Timestamp": 1672084800,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672088400,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672092000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1672128000,
                                "Value": 0
                            }
                        ],
                        "Max": 25812,
                        "MetricName": "l7Flow_outFlux_hy",
                        "Sum": 26973
                    },
                    {
                        "Avg": 0,
                        "Detail": [
                            {
                                "Timestamp": 1671552000,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671555600,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671559200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1671868800,
                                "Value": 0
                            }
                        ],
                        "Max": 394,
                        "MetricName": "l7Flow_inBandwidth_hy",
                        "Sum": 418
                    }
                ]
            }
        ],
        "TotalCount": 1
    }
}

    Example3 Querying the L7 time-series data of origin-pull

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTimingL7SourceData
<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_hy"
    ]
}

    Output Example

    {
    "Response": {
        "RequestId": "141a7ccd-9713-43a2-91d5-1b47692d0609",
        "TimingDataRecords": [
            {
                "TypeKey": "251227260",
                "TypeValue": [
                    {
                        "Avg": 803,
                        "Detail": [
                            {
                                "Timestamp": 1659139200,
                                "Value": 0
                            },
                            {
                                "Timestamp": 1661731200,
                                "Value": 0
                            }
                        ],
                        "Max": 7921,
                        "MetricName": "l7Flow_request_hy",
                        "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.
    LimitExceeded The quota limit has been reached.
    OperationDenied Operation denied.
    ResourceUnavailable The resource is unavailable.
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy