tencent cloud

APIs

文档APIsTencent Cloud EdgeOneLog Service APIsCreateRealtimeLogDeliveryTask

CreateRealtimeLogDeliveryTask

下载
聚焦模式
字号
最后更新时间： 2026-06-10 14:46:19

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 limits apply:
-When the data delivery type (LogType) is site acceleration log (Layer 7 Access Logs), four-layer proxy logs, or edge function logs, the same entity (L7 domain, L4 proxy instance, or edge function instance) under the same combination of data delivery type (LogType) and data delivery area (Area) can only be added to the following real-time log delivery task type (TaskType) combinations:
-A task to push to Tencent Cloud CLS, add another task to push to a custom HTTP(S) address.
-A task to push to Tencent Cloud CLS, add another task to push to S3-compatible object storage.
-When the data delivery type (LogType) is rate limit and CC attack defense log, managed rule log, custom rule log, or Bot Management Log, an entity can only be added to one real-time log delivery task under the combination of the same data delivery type (LogType) and data delivery area (Area).
-When the real-time log delivery task type (TaskType) is EdgeOne log analysis (log_analysis), it supports only data delivery type (LogType) as site acceleration log (domain) or managed rule log (web-attack). Under the same site (ZoneId), same data delivery area (Area), and data combination, each data delivery type (LogType) can only add one real-time log delivery task pushed to EdgeOne log analysis.

It is recommended to first query the real-time log delivery task list according to the entity via the DescribeRealtimeLogDeliveryTasks API, and check whether the entity has been added to another real-time log delivery task.

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: CreateRealtimeLogDeliveryTask.
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 Zone ID.
Area Yes String Data shipping area. Available values:
  • mainland: within the Chinese mainland;
  • overseas: global (excluding the Chinese mainland).
LogType Yes String Data delivery type. Available values:
  • domain: site acceleration log;
  • application: four-layer proxy logs;
  • function: edge function logs;
  • web-rateLiming: rate limit and CC attack defense log;
  • web-attack: managed rule log;
  • web-rule: custom rule logs;
  • web-bot: bot management log.
TaskName Yes String Name of a real-time log delivery task, which can contain up to 200 characters, including digits, English letters, hyphens (-) and underscores (_).
TaskType Yes String Type of a real-time log shipping task. Valid values:
  • cls: push to Tencent Cloud CLS;
  • custom_endpoint: push to a custom HTTP(S) address;
  • s3: push to an AWS S3-compatible bucket address;
  • log_analysis: push to EdgeOne log analytics. Only supported when LogType = domain or web-attack.
EntityList.N Yes Array of String List of entities corresponding to the real-time log delivery task. Example values are as follows:
  • Layer 7 domain: domain.example.com
  • L4 proxy instance: sid-2s69eb5wcms7
  • Cloud function instance: test-zone-2mxigizoh9l9-1257626257

Reference for values
DescribeL4Proxy
DescribeAccelerationDomains
DescribeFunctions
Fields.N Yes Array of String Predefined fields for delivery. Value reference:
CustomFields.N No Array of CustomField The list of custom fields for log delivery, which supports extracting specified content from HTTP request headers, response headers, cookies, and request bodies. Custom field names must be unique. The number of custom fields cannot exceed a maximum of 200. A single real-time log delivery task can configure up to 5 custom fields of the request body type. Currently, only site acceleration logs (LogType=domain) support custom fields.
DeliveryConditions.N No Array of DeliveryCondition Filter criteria of log delivery. If this parameter is not specified, all logs will be delivered.
Sample No Integer Sampling ratio in permille. Value range: 1-1000. For example, 605 indicates a sampling ratio of 60.5%. If this parameter is not specified, the sampling ratio is 100%.
LogFormat No LogFormat Output format for log delivery. If left empty, the default format is used. The default format logic is as follows:
  • When TaskType is 'custom_endpoint', the default format is an array of JSON objects, each JSON object represents a log entry;
  • When TaskType is 's3', the default format is JSON Lines;
Particularly, when TaskType is 'cls' or 'log_analysis', the only allowed value for LogFormat.FormatType is 'json', and other parameters in LogFormat will be ignored. It is recommended not to transfer LogFormat.
CLS No CLSTopic Configuration information of CLS. This parameter is required when TaskType is cls.
CustomEndpoint No CustomEndpoint Configuration information of the custom HTTP endpoint. This parameter is required when TaskType is custom_endpoint.
S3 No S3 Configuration information of the AWS S3-compatible bucket. This parameter is required when TaskType is s3.

3. Output Parameters

Parameter Name Type Description
TaskId String ID of the successfully created task.
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 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, deliver data for site acceleration logs generated by domain.example.com in Chinese mainland, with fields included such as RequestID, ClientIP, RequestTime, and field value extracted from request header Accept-Language, and configure the sampling ratio as 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-2z55fgysdtmc",
    "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, deliver data with the range of site acceleration log generated by domain.example.com in Chinese mainland with final security handling method as interception or challenge, fields included are RequestID, ClientIP, RequestTime, log sampling is disabled, log delivery compression is enabled, and custom request header Vendor carried during log delivery with constant value of EdgeOne.

Input Example

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

{
    "ZoneId": "zone-2z55fgysdtmc",
    "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"
    }
}

Example3 Creating a Log Delivery Task with AWS S3-Compatible Bucket As Destination, Delivering Site Acceleration Logs Generated for domain.example.com in Chinese Mainland, Fields Included: RequestID, ClientIP, RequestTime, and Accept-Language

This example shows you how to create a log delivery task with AWS S3-compatible bucket as destination, delivering site acceleration logs generated for domain.example.com in Chinese mainland with final security handling method as interception or challenge. Fields included: RequestID, ClientIP, RequestTime. Log sampling is disabled, log delivery compression is enabled, and custom request header Vendor carried during log delivery with constant value of EdgeOne. The bucket selected is Tencent Cloud's COS.

Input Example

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

{
    "ZoneId": "zone-2z55fgysdtmc",
    "TaskName": "test_log_task",
    "TaskType": "s3",
    "EntityList": [
        "domain.example.com"
    ],
    "LogType": "domain",
    "Area": "mainland",
    "Fields": [
        "RequestID",
        "ClientIP",
        "RequestTime"
    ],
    "CustomFields": [
        {
            "Name": "ReqHeader",
            "Value": "Accept-Language",
            "Enabled": true
        }
    ],
    "Sample": 605,
    "S3": {
        "Endpoint": "https://example.cos.ap-guangzhou.myqcloud.com",
        "Region": "ap-guangzhou",
        "Bucket": "example-bucket-4-1310765013/example-4-1310765013/logs/EdgeOne/test",
        "CompressType": "",
"AccessId": "Your bucket access key ID"
"AccessKey": "Your bucket access key KEY"
    }
}

Output Example

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

Example4 Creating a Log Delivery Task with EdgeOne Log Analytics As the Destination

This example shows you how to create a log delivery task with EdgeOne Log Analytics as destination, delivering site acceleration logs generated for domain.example.com in Chinese mainland, fields included: RequestID, ClientIP, RequestTime, and field value extracted from Accept-Language request header, with sampling ratio set to 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-2z55fgysdtmc",
    "TaskName": "test_log_task",
    "TaskType": "log_analysis",
    "EntityList": [
        "domain.example.com"
    ],
    "LogType": "domain",
    "Area": "mainland",
    "Fields": [
        "RequestID",
        "ClientIP",
        "RequestTime"
    ],
    "CustomFields": [
        {
            "Name": "ReqHeader",
            "Value": "Accept-Language",
            "Enabled": true
        }
    ],
    "Sample": 605
}

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.

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.
FailedOperation.CreateClsLogSetFailed Failed to create the log set. Check whether the log set name already exists.
FailedOperation.CreateClsLogTopicTaskFailed Failed to create the log topic task. Check whether the log topic name or task name already exists.
FailedOperation.CreateLogTopicTaskAuthFailure Authentication failed while creating a custom push task. Check whether the push address is correct.
FailedOperation.RealtimeLogAuthFailure The real-time log authentication failed.
FailedOperation.RealtimeLogNotFound The real-time log push task does not exist.
InvalidParameter Parameter error.
InvalidParameter.InvalidLogFormatFieldDelimiter The field separator in the log output format is incorrect.
InvalidParameter.InvalidLogFormatFormatType The log output format type is incorrect.
InvalidParameter.InvalidLogFormatRecordDelimiter The log record separator in the log output format is incorrect.
InvalidParameter.RealtimeLogEntityAlreadyCreated The push instance has been created.
InvalidParameter.RealtimeLogInvalidDeliveryArea The log push region is invalid.
InvalidParameter.RealtimeLogInvalidLogType The log push type is invalid.
InvalidParameter.RealtimeLogInvalidTaskType The real-time log delivery type is invalid.
InvalidParameter.RealtimeLogNumsExceedLimit The real-time log push task data exceeded the limit.
InvalidParameterValue Invalid parameter value.
LimitExceeded The quota limit has been reached.
LimitExceeded.CustomLogFieldRegexLimitExceeded The number of regular expression type fields in real-time log custom fields exceeds the limit.
OperationDenied Operation denied.
ResourceNotFound The resource doesn’t exist.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
上一篇: CreateCLSIndex下一篇: ModifyRealtimeLogDeliveryTask

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈