采集配置

最后更新时间:2021-05-21 16:41:01

    描述

    获取 agent 对应的采集配置。

    请求

    请求行

    GET /agent/config

    请求示例

    GET /agent/config HTTP/1.1Host: <Region>.cls.myqcloud.comAuthorization: <AuthorizationString>

    请求头

    Header名 含义
    x-cls-agent-version agent 的版本号
    x-cls-agent-ip agent 的 IP 地址

    请求参数

    响应

    返回示例

    HTTP / 1.1 200 OKContent - Type: application / jsonContent - Length: 123 {
        "logconf": [{
            "topicid": "xxxx-xx-xx-xx-yyyyyyyy",
            "path": "/abc/log/test.log",
            "wildpath": "/abc/log/test.log",
            "multi_wildpath": ["abc/test.log", "acb/test.log"],
            "log_type": "delimiter_log",
            "extract_rule": {
                "time_key": "data",
                "time_format": "%t",
                "delimiter": "|",
                "keys": ["data", "", "content"],
                "filter_keys": [],
                "filter_regex": [],
            }
        }, {
            "topicid": "xxxx-xx-xx-xx-yyyyzzzz",
            "path": "/abc/log/test1.log",
            "wildpath": "/abc/log/test.log",
            "multi_wildpath": ["abc/test.log", "acb/test.log"],
            "log_type": "regex_log",
            "extract_rule": {
                "log_regex": "(.*)",
                "beginning_regex": "^abc",
                "keys": ["content"],
                "filter_keys": [],
                "filter_regex": [],
            }
        }],
        "needupdate": true,
        "last_version": "1.0.1",
        "url": "http://test-11101.cossh.myqcloud.com/xxx.so",
        "file_md5": "aee24235afdscrt4safewf"
    }

    响应头

    无特殊

    返回内容说明

    字段名 类型 是否必选 含义
    logconf JsonArray(ColInfo) 日志的采集信息
    needupdate bool agent 是否需要更新
    last_version string agent 最新的版本号,需要更新时返回
    url string agent 的下载地址,需要更新时返回
    file_md5 string agent 的 MD5 值,需要更新时返回

    ColInfo 格式如下:

    字段名 类型 是否必选 含义
    topicid string 日志主题的 ID
    path string 采集的路径(兼容旧版本采集路径,multi_wildpath,wildpath 和 path 只会返回其中一个)
    wildpath string 采集的路径(新版本采集路径,multi_wildpath,wildpath 和 path 只会返回其中一个)
    multi_wildpath string 采集的路径(新版本采集路径,multi_wildpath,wildpath 和 path 只会返回其中一个)
    log_type string 日志类型
    extract_rule object 提取规则

    extract_rule 格式如下:

    字段名 类型 是否必选 含义
    time_key string 日志中时间的 key
    time_format string 时间的格式
    delimiter string 分隔符,delimiter_log 类型的日志时返回
    log_regex string 整个日志的提取规则,regex_log 类型的日志时返回
    beginning_regex string 多行日志的首行匹配规则,regex_log 类型的日志时返回
    keys array(string) key 名字列表
    filter_keys array(string) 过滤的key名字列表
    filter_regex array(string) 过滤的正则

    错误码

    请参见 错误码 文档。