tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
日志服务
    文档
    Download PDF

    ModifyConfig

    最后更新时间：2024-04-19 10:04:09
    下载PDF

      1. API Description

      Domain name for API request: cls.tencentcloudapi.com.

      This API is used to modify collection rule configuration.

      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: ModifyConfig.
      Version Yes String Common Params. The value used for this API: 2020-10-16.
      Region No String Common Params. This parameter is not required for this API.
      ConfigId Yes String Collection rule configuration ID, accessed through Access collection rule configuration.
      Name No String Collection rule configuration name
      Path No String Log collection path containing the filename
      LogType No String The types of logs collected. Supported types are:
      - json_log: JSON File Log (For more information, see Using JSON pattern to collect logs);- delimiter_log: Delimiter - File Logs (For more information, see Using delimiter pattern to collect logs);- minimalist_log: Single-line Full-text File Log (For more information, see Using single-line full-text pattern to collect logs);- fullregex_log: Single line full regular expression - File log (For more information, see Using single-line - complete regular expression pattern to collect logs);- multiline_log: Multiline Full-text File Log (For more information, see Using multi-line full-text pattern to collect logs);- multiline_fullregex_log: Multi-line complete regular expression - File Logs (For more information, see Using multi-line - complete regular expression pattern to collect logs);- user_define_log: Combined parsing (Suitable for logs with multiple nested formats, see Using combined parsing pattern to collect logs);- service_syslog: syslog collection (For more information, see Collect Syslog);- windows_event_log: Windows event log (For more information, see Collect Windows Event Log).
      ExtractRule No ExtractRuleInfo Extraction rule. If ExtractRule is set, LogType must be set.
      ExcludePaths.N No Array of ExcludePathInfo Collection path blocklist
      Output No String Log topic (TopicId) associated with collection configuration
      UserDefineRule No String Custom parsing string, serialized as a JSON string.
      AdvancedConfig No String Advanced collection configuration. A JSON string, Key/Value definition as follows:
      - ClsAgentFileTimeout (timeout property), value range: an integer greater than or equal to 0, where 0 means no timeout- ClsAgentMaxDepth (maximum directory depth), value range: an integer greater than or equal to 0
      - ClsAgentParseFailMerge (merge logs that failed parsing), value range: true or false
      Sample:
      {\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}

      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 Modifying Collection Rule Configuration

      FilterKeyRegex: Loglistener log filter rule list (earlier version), log keys that need to be filtered and their corresponding regex. Note: For LogListener versions 2.9.3 and later, it's recommended to use the AdvanceFilterRules configuration for log filtering.

      Input Example

      POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyConfig
<Common request parameters>
{
    "Path": "/data/log/**/my.log",
    "ExcludePaths": [
        {
            "Type": "Path",
            "Value": "/data/log/my.log"
        }
    ],
    "Name": "test2.8.8",
    "LogType": "minimalist_log",
    "UserDefineRule": "",
    "ExtractRule": {
        "IsGBK": 0,
        "FilterKeyRegex": [
            {
                "Key": "__CONTENT__",
                "Regex": "400|500"
            }
        ],
        "Backtracking": 0,
        "MetadataType": 2,
        "MetaTags": [
            {
                "Key": "mryx",
                "Value": "item"
            }
        ],
        "PathRegex": ""
    },
    "AdvancedConfig": "{\"ClsAgentFileTimeout\":3600}",
    "ConfigId": "a2c6342c-270a-4468-86cf-92625e466401"
}

      Output Example

      {
    "Response": {
        "RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}

      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
      AuthFailure CAM signature/authentication error.
      FailedOperation Operation failed.
      InternalError Internal error.
      InvalidParameter Incorrect parameter.
      InvalidParameter.ConfigConflict The same collection configuration rule already exists.
      InvalidParameterValue Incorrect parameter value.
      MissingParameter Missing parameter.
      OperationDenied Operation denied.
      OperationDenied.AccountDestroy The account has been terminated.
      OperationDenied.AccountIsolate The account has overdue payments.
      OperationDenied.AccountNotExists The account does not exist.
      ResourceNotFound The resource does not exist.
      ResourceNotFound.ConfigNotExist The specified collection rule configuration does not exist.
      ResourceNotFound.TopicNotExist The log topic does not exist.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款