tencent cloud

APIs

DocumentaçãoAPIsTencent Cloud EdgeOneLog Service APIsDescribeLogAnalysisDownloadTasks

DescribeLogAnalysisDownloadTasks

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-10-22 15:27:22

1. API Description

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

This API is used to query the log download task list for log analysis. Note: Only download task records from the last three days are retained.

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: DescribeLogAnalysisDownloadTasks.
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.
LogType No String

Log type. Available values:

  • l7-access-logs: Layer 7 Access Logs;
  • web-attack: Managed Rule Logs.
Defaults to l7-access-logs.
Filters.N No Array of AdvancedFilter

Filtering Conditions. The maximum number of Filters.Values is 20. Detailed filter criteria are as follows:

  • task-id: Filter by log download task id. For optional Values, refer to the TaskId returned by the CreateLogAnalysisDownloadTask api.

For reference: CreateLogAnalysisDownloadTask
Limit No Integer

Paginated query limit. Default value: 20, maximum value: 100.
Offset No Integer

Paginated query offset, defaults to 0.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Total number of entries for the log analysis download task that meets the match condition.
Tasks Array of LogAnalysisDownloadTask

Download task list for log analysis that meets the log 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 Querying the log analysis log download task list

Query the download task list for log analytics with the ZoneId "zone-2z55fgysdtmc", data ownership region Chinese mainland, and log type Layer 7 Access Logs.

Input Example

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

{
    "ZoneId": "zone-2z55fgysdtmc",
    "Area": "mainland",
    "Limit": 20,
    "Offset": 0
}

Output Example

{
    "Response": {
        "RequestId": "88e4f1a4-ee44-42e9-8aa8-a9b1631ecc5e",
        "TotalCount": 1,
        "Tasks": [
            {
                "TaskId": "export-c99fd900-1bcb-4137-8405-496462dce729",
                "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']",
                "Format": "csv",
                "Status": "loading",
                "Sort": "desc",
                "CreateTime": "2025-07-15T00:00:00+08:00",
                "ExpireTime": "2025-07-18T23:59:59+08:00"
            },
            {
                "TaskId": "export-d2ee4f62-54ea-4a9b-8fb8-850e3fd56038",
                "ZoneId": "zone-2z55fgysdtmc",
                "Area": "mainland",
                "StartTime": "2025-07-11T00:00:00+08:00",
                "EndTime": "2025-07-12T00:00:00+08:00",
                "LogType": "l7-access-logs",
                "Condition": "${RequestHost} in ['www.example.com'] AND ${EdgeCacheStatus} in ['hit','miss']",
                "Format": "csv",
                "Status": "completed",
                "Url": "https://export-gz-1254077820.cos.ap-guangzhou.myqcloud.com/%2Fexport/20260611/log_438167613_337ec735-21bc-4079-af63-7895ded64a92_20260611_expo*********************************************************************************************************************************************168%3B1781184768&q-key-time=1781181168%3B1781184768&q-header-list=host&q-url-param-list=&q-signature=c8a72b4c4c70443e55901c25cf489112ce85329a",
                "Sort": "desc",
                "CreateTime": "2025-07-16T00:00:00+08:00",
                "ExpireTime": "2025-07-19T23:59:59+08:00"
            }
        ]
    }
}

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.RealtimeLogLogAnalysisNotSupport Currently, creation of real-time log push tasks for EdgeOne log analytics is not supported.
InvalidParameter.InvalidLogAnalysisCondition Invalid log analysis match condition. Query statement parsing failed.
Anterior: DescribeLogAnalysisDetailPróximo: CreatePlan

Ajuda e Suporte

Esta página foi útil?

comentários

Search
    Enter keywords to search documentation