tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ModifyRealtimeLogDeliveryTask

最后更新时间：2024-12-03 16:17:23

1. API Description

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

This API is used to modify the real-time log delivery task configuration. This API has the following restrictions:

  • Does not support modifying the destination type of the real-time log delivery task (TaskType);
  • Does not support modifying the data delivery type (LogType);
  • Does not support modifying the data delivery area (Area);
  • Does not support modifying the detailed destination configuration, such as log set and log topic, when the destination of the original real-time log delivery task is Tencent Cloud CLS.

    • 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: ModifyRealtimeLogDeliveryTask.
    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.
    TaskId Yes String The ID of the real-time log delivery task.
    TaskName No String The name of the real-time log delivery task, which is a combination of numbers, English letters, - and _, containing up to 200 characters. If this field is not filled in, the original configuration will be retained.
    DeliveryStatus No String The status of the real-time log delivery task. Valid values:
  • enabled: Enabled;
  • disabled: Disabled.
    • If this field is not filled in, the original configuration will be retained.
    EntityList.N No Array of String The list of entities (Layer 7 domains or Layer 4 proxy instances) corresponding to the real-time log delivery task. Valid value examples:
  • Layer 7 domain: domain.example.com;
  • Layer 4 proxy instance: sid-2s69eb5wcms7.
    • If this field is not filled in, the original configuration will be retained.
    Reference for values
    DescribeAccelerationDomains
    DescribeApplicationProxies
    Fields.N No Array of String The list of predefined fields for delivery. If this field is not filled in, the original configuration will be retained.
    CustomFields.N No Array of CustomField The list of custom fields for shipping, which supports extracting specified content from HTTP request headers, response headers, cookies, and request bodies. If this parameter is not filled in, the original configuration will be retained. The name of each custom field should be unique and the maximum number of fields is 200. Up to 5 custom fields of the request body type can be added for a single real-time log push task. Currently, adding custom fields is supported only for site acceleration logs (LogType=domain).
    DeliveryConditions.N No Array of DeliveryCondition Log delivery filter conditions. If this field is not filled in, all logs will be delivered.
    Sample No Integer The sampling ratio in permille. Value range: 1 to 1000. For example, 605 represents a sampling ratio of 60.5%. If this field is not filled in, the original configuration will be retained.
    LogFormat No LogFormat Output format for log delivery. If this field is not specified, the original configuration will be retained. Specifically, when TaskType is cls, the value of LogFormat.FormatType can only be json, and other parameters in LogFormat will be ignored. It is recommended not to input LogFormat.
    CustomEndpoint No CustomEndpoint The configuration information of the custom HTTP service. If this field is not filled in, the original configuration will be retained.
    S3 No S3 The configuration information of the AWS S3-compatible bucket. If this field is not filled in, the original configuration will be retained.

    3. Output Parameters

    Parameter Name Type Description
    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 Disabling Log Sampling

    This example shows you how to modify the configuration of a successfully created real-time log delivery task and disable its log sampling feature. Before modification, the log sampling ratio is 60.5%. After modification, log sampling will no longer be performed, and 100% of the logs will be delivered to the destination.

    Input Example

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

{
    "ZoneId": "zone-2ju9lrnpayol",
    "TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
    "Sample": 1000
}

    Output Example

    {
    "Response": {
        "RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
    }
}

    Example2 Adding Acceleration Domains for Log Delivery

    This example shows you how to modify the configuration of a successfully created real-time log delivery task and add acceleration domains for which logs need to be delivered. Before modification, only the site acceleration log of domain1.example.com is delivered. After modification, the site acceleration logs of domain1.example.com, domain2.example.com, and domain3.example.com will be delivered.

    Input Example

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

{
    "ZoneId": "zone-2ju9lrnpayol",
    "TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
    "EntityList": [
        "domain1.example.com",
        "domain2.example.com",
        "domain3.example.com"
    ]
}

    Output Example

    {
    "Response": {
        "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.CreateLogTopicTaskAuthFailure Authentication failed while creating a custom push task. Check whether the push address is correct.
    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.
    LimitExceeded.CustomLogFieldRegexLimitExceeded The number of regular expression type fields in real-time log custom fields exceeds the limit.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款