修改采集规则配置

最近更新时间:2024-10-15 01:07:51

我的收藏

1. 接口描述

接口请求域名: cls.tencentcloudapi.com 。

修改采集规则配置

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyConfig。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
ConfigId String 采集规则配置ID,通过获取采集规则配置返回信息获取。
示例值:a2c6342c-270a-4468-86cf-92625e466401
Name String 采集规则配置名称
示例值:testname
Path String 日志采集路径,包含文件名
示例值:/data/nginx/log/access.log
LogType String 采集的日志类型。支持以下类型:
- json_log代表:JSON-文件日志(详见使用 JSON 提取模式采集日志);
- delimiter_log代表:分隔符-文件日志(详见使用分隔符提取模式采集日志);
- minimalist_log代表:单行全文-文件日志(详见使用单行全文提取模式采集日志);
- fullregex_log代表:单行完全正则-文件日志(详见使用单行-完全正则提取模式采集日志);
- multiline_log代表:多行全文-文件日志(详见使用多行全文提取模式采集日志);
- multiline_fullregex_log代表:多行完全正则-文件日志(详见使用多行-完全正则提取模式采集日志);
- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见使用组合解析提取模式采集日志);
- service_syslog代表:syslog 采集(详见采集 Syslog);
- windows_event_log代表:Windows事件日志(详见采集 Windows 事件日志)。


示例值:delimiter_log
ExtractRule ExtractRuleInfo 提取规则,如果设置了ExtractRule,则必须设置LogType
ExcludePaths.N Array of ExcludePathInfo 采集黑名单路径列表
Output String 采集配置关联的日志主题(TopicId)
示例值:57f5808c-4a55-11eb-b378-0242ac130002
UserDefineRule String 用户自定义解析字符串,Json格式序列化的字符串。
示例值:"{"processors":[{"type":"processor_split_delimiter","detail":{"Delimiter":",","ExtractKeys":["time","msg1","msg2"]},"processors":[{"type":"processor_timeformat","detail":{"KeepSource":true,"TimeFormat":"%s","SourceKey":"time"}},{"type":"processor_split_delimiter","detail":{"KeepSource":false,"Delimiter":"|","SourceKey":"msg1","ExtractKeys":["submsg1","submsg2","submsg3"]},"processors":[]},{"type":"processor_split_key_value","detail":{"KeepSource":false,"Delimiter":":","SourceKey":"msg2"}}]}]}"
AdvancedConfig String 高级采集配置。 Json字符串, Key/Value定义为如下:
- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
样例:
{\"ClsAgentFileTimeout\":0,\"ClsAgentMaxDepth\":10,\"ClsAgentParseFailMerge\":true}
示例值:"{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}"

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改采集规则配置

FilterKeyRegex:Loglistener日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。
注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyConfig
<公共请求参数>

{
    "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": "",
        "AdvanceFilterRules": []
    },
    "AdvancedConfig": "{\"ClsAgentFileTimeout\":3600}",
    "ConfigId": "a2c6342c-270a-4468-86cf-92625e466401"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ConfigConflict 相同的采集配置规则已经存在。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound 资源不存在。
ResourceNotFound.ConfigNotExist 指定的采集规则配置不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。