DescribeLogAnalysisDetail

1. API Description

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

This API is used to query the log analysis details. The data comes from the log data of the real-time log push task with the destination "log_analysis" under the site.

A maximum of 10 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: DescribeLogAnalysisDetail.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required.
ZoneId	Yes	String	Site ID.
Area	Yes	String	Data service area. Available values: mainland: within the Chinese mainland; overseas: global (excluding Mainland China). Note: If the site service area is "global availability zone", you need to query the data of mainland and overseas separately to obtain all data.
StartTime	Yes	Timestamp ISO8601	Start time, example value: 2020-04 29T00:00:00Z. The maximum span supported for query start time to this day varies by package version. For more details, see Package Selection Comparison.
EndTime	Yes	Timestamp ISO8601	End time, example value: 2020-04-30T00:00:00Z. The maximum duration from the start time to the end time per request is 31 days.
LogType	No	String	Log type. Available values: l7-access-logs: Layer 7 Access Logs; web-attack: Managed Rule Logs. Defaults to l7-access-logs.
Condition	No	String	Log match condition. Maximum length 12KB.
Limit	No	Integer	Paginated query limit. Default value: 20, maximum value: 100.
Offset	No	Integer	Paginated query offset, defaults to 0.
Sort	No	String	Whether raw logs are returned in time sequence. Available values: asc: ascending order; desc: descending order. Default is desc.

3. Output Parameters

Parameter Name	Type	Description
LogDetail	Array of LogItem	Log details list that meets the log match condition.
TotalCount	Integer	Total number of logs that meet the match condition.
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 logs and analyze log details

Query the data details of Layer 7 Access Logs for the selected site with ID "zone-2z55fgysdtmc", associated region Chinese mainland, between UTC+8 2025-07-10 00:00:00 ~ 2025-07-11 00:00:00, in reverse chronological order. Log match condition: request domain is "www.example.com" and hit status is "hit" or "cache miss".

Input Example

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

{
    "ZoneId": "zone-2z55fgysdtmc",
    "Area": "mainland",
    "StartTime": "2025-07-10T00:00:00+08:00",
    "EndTime": "2025-07-11T00:00:00+08:00",
    "LogType": "l7-access-logs",
    "Condition": "${RequestHost} in ['www.example.com'] AND ${EdgeCacheStatus} in ['hit','miss']",
    "Limit": 100,
    "Offset": 0,
    "Sort": "desc"
}

Output Example

{
    "Response": {
        "RequestId": "88e4f1a4-ee44-42e9-8aa8-a9b1631ecc5e",
        "LogDetail": [
            {
                "Timestamp": 1752137534000,
                "LogJson": "{\"RequestID\":\"13719873400581239472\",\"RequestSSLProtocol\":\"-\",\"RequestScheme\":\"HTTPS\",\"LogTime\":\"2025-07-10T08:52:14Z\",\"EdgeResponseStatusCode\":404,\"ClientIP\":\"0.0.0.0\",\"RequestHost\":\"www.example.com\",\"RequestProtocol\":\"HTTP/1.1\",\"EdgeCacheStatus\": \"hit\",\"RequestUA\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36\",\"EdgeServerIP\":\"0.0.0.0\"}"
            },
            {
                "Timestamp": 1752135679000,
                "LogJson": "{\"RequestID\":\"13719873400528347025\",\"RequestSSLProtocol\":\"-\",\"RequestScheme\":\"HTTPS\",\"LogTime\":\"2025-07-10T08:21:19Z\",\"EdgeResponseStatusCode\":200,\"ClientIP\":\"0.0.0.0\",\"RequestHost\":\"www.example.com\",\"RequestProtocol\":\"HTTP/1.1\",\"EdgeCacheStatus\": \"hit\",\"RequestUA\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36\",\"EdgeServerIP\":\"0.0.0.0\"}"
            },
            {
                "Timestamp": 1752134456000,
                "LogJson": "{\"RequestID\":\"13719873400520394827\",\"RequestSSLProtocol\":\"-\",\"RequestScheme\":\"HTTPS\",\"LogTime\":\"2025-07-10T08:00:56Z\",\"EdgeResponseStatusCode\":200,\"ClientIP\":\"0.0.0.0\",\"RequestHost\":\"www.example.com\",\"RequestProtocol\":\"HTTP/1.1\",\"EdgeCacheStatus\": \"hit\",\"RequestUA\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36\",\"EdgeServerIP\":\"0.0.0.0\"}"
            },
            {
                "Timestamp": 1752131866310,
                "LogJson": "{\"RequestID\":\"13719873400524368235\",\"RequestSSLProtocol\":\"-\",\"RequestScheme\":\"HTTPS\",\"LogTime\":\"2025-07-10T07:16:40Z\",\"EdgeResponseStatusCode\":200,\"ClientIP\":\"0.0.0.0\",\"RequestHost\":\"www.example.com\",\"RequestProtocol\":\"HTTP/1.1\",\"EdgeCacheStatus\": \"hit\",\"RequestUA\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36\",\"EdgeServerIP\":\"0.0.0.0\"}"
            }
        ],
        "TotalCount": 4
    }
}

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

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
- Example1 Query logs and analyze log details
5. Developer Resources
- SDK
- Command Line Interface
6. Error Code