tencent cloud

Feedback

DescribeTimingL7CacheData

Last updated: 2022-09-01 15:05:37

1. API Description

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

This API is used to query time-series L7 cached 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 Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeTimingL7CacheData.
Version Yes String Common Params. The value used for this API: 2022-01-06.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
StartTime Yes Timestamp ISO8601 Start time of the query (client time in RFC 3339)
EndTime Yes Timestamp ISO8601 Start time of the query (client time in RFC 3339)
MetricNames.N Yes Array of String Supported metrics for data query:
l7Cache_outFlux: Access traffic
l7Cache_request: Access requests
Interval Yes String Time interval. Values: {min, 5min, hour, day, week}
ZoneIds.N No Array of String List of site IDs
Filters.N No Array of Filter Filter condition:
{Key: "cacheType", Value: ["hit"], Operator: "equals"}: Filter by data responded from EdgeOne
{Key: "cacheType", Value: ["miss", "dynamic"], Operator: "equals"}: Filter by data responded from the origin server

3. Output Parameters

Parameter Name Type Description
Data Array of TimingDataRecord Details
Note: This field may return null, indicating that no valid values can be obtained.
Type String Metric specified for data query
Interval String Time interval
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying traffic data from the layer-7 cache analysis

Input Example

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

{
    "StartTime": "2020-09-22T00:00:00+00:00",
    "MetricNames": [
        "xx"
    ],
    "Interval": "xx",
    "ZoneIds": [
        "xx"
    ],
    "Filters": [
        {
            "Operator": "xx",
            "Value": [
                "xx"
            ],
            "Key": "xx"
        }
    ],
    "EndTime": "2020-09-22T00:00:00+00:00"
}

Output Example

{
    "Response": {
        "Type": "xx",
        "Interval": "xx",
        "Data": [
            {
                "TypeKey": "xx",
                "TypeValue": [
                    {
                        "Max": 0,
                        "Sum": 0,
                        "Detail": [
                            {
                                "Timestamp": 0,
                                "Value": 0
                            }
                        ],
                        "DetailData": [
                            0
                        ],
                        "Avg": 0,
                        "MetricName": "xx"
                    }
                ]
            }
        ],
        "RequestId": "xx"
    }
}

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
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation.CamUnauthorized CAM is not authorized.
Contact Us

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

Technical Support

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

7x24 Phone Support