1. API Description

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

This API is used to create a real-time log delivery task.
The following restrictions apply:

• When the log type (LogType) is site acceleration log (L7 access log) (domain), L4 proxy log (application), or Edge Function execution log (function), the same entity (L7 domain, L4 proxy instance, or Edge Function instance) can be added to only one of the following TaskType combinations within the same LogType-Area pair:
  • One task delivering to Tencent Cloud CLS plus one task delivering to a custom HTTP(S) endpoint;
  • One task delivering to Tencent Cloud CLS plus one task delivering to an AWS S3-compatible bucket.
• When the log type (LogType) is rate-limiting & CC attack protection log (web-rateLiming), managed rule log (web-attack), custom rule log (web-rule), or bot management log (web-bot), the same entity can be added to only one real-time log delivery task within the same LogType-Area pair.

Before creating a task, we recommend that you first call DescribeRealtimeLogDeliveryTasks to list existing tasks for the entity and verify whether it has already been added to another task.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Creating a Log Delivery Task with the Destination Set to Tencent Cloud CLS

This example shows you how to create a log delivery task with the destination set to Tencent Cloud CLS. The delivery data range includes the site acceleration log generated by domain.example.com in the Chinese mainland. The data includes the RequestID, ClientIP, and RequestTime fields, and field values extracted from the Accept-Language request header. The configuration sampling ratio is 60.5%.

Input Example

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

{
    "ZoneId": "zone-xxxxx",
    "TaskName": "test_log_task",
    "TaskType": "cls",
    "EntityList": [
        "domain.example.com"
    ],
    "LogType": "domain",
    "Area": "mainland",
    "Fields": [
        "RequestID",
        "ClientIP",
        "RequestTime"
    ],
    "CustomFields": [
        {
            "Name": "ReqHeader",
            "Value": "Accept-Language",
            "Enabled": true
        }
    ],
    "Sample": 605,
    "CLS": {
        "LogSetId": "1a6efff1-0e40-4d37-a4ed-02c92513406b",
        "TopicId": "0b3a07c0-5cf6-4017-8a75-cd4459aea588",
        "LogSetRegion": "ap-guangzhou"
    }
}

Output Example

{
    "Response": {
        "TaskId": "26580056-1187-43ed-b2c7-ecdb5bae0b46",
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
    }
}

Example2 Creating a Log Delivery Task with the Destination Set to a Custom HTTP Service

This example shows you how to create a log delivery task with the destination set to a custom HTTP service. The delivery data range includes the site acceleration log generated by domain.example.com in the Chinese mainland and with the final security handling method being interception or challenge. The data includes the RequestID, ClientIP, and RequestTime fields. Log sampling is disabled, log delivery compression is enabled, and the custom request header Vendor with a constant value of EdgeOne is carries during log delivery.

Input Example

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

{
    "ZoneId": "zone-xxxxx",
    "TaskName": "test_log_task",
    "TaskType": "custom_endpoint",
    "EntityList": [
        "domain.example.com"
    ],
    "LogType": "domain",
    "Area": "mainland",
    "Fields": [
        "RequestID",
        "ClientIP",
        "RequestTime"
    ],
    "Sample": 1000,
    "DeliveryConditions": [
        {
            "Conditions": [
                {
                    "Key": "SecurityAction",
                    "Operator": "equal",
                    "Value": [
                        "Deny",
                        "JSChallenge",
                        "ManagedChallenge"
                    ]
                }
            ]
        }
    ],
    "CustomEndpoint": {
        "Url": "http://custom_endpoint/access_log/post",
        "CompressType": "gzip",
        "Headers": [
            {
                "Name": "Vendor",
                "Value": "EdgeOne"
            }
        ]
    }
}

Output Example

{
    "Response": {
        "TaskId": "26580056-1187-43ed-b2c7-ecdb5bae0b46",
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.