有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

本接口用于修改特殊采集配置任务,特殊采集配置应用于自建K8S环境的采集Agent

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyConfigExtra。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
ConfigExtraId String 采集配置扩展信息id
示例值:xxx-xxx-xxx-xxx
Name String 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
示例值:table-xxx1
TopicId String 日志主题id
示例值:xxx-xxx-xxx-xxx
HostFile HostFileInfo 节点文件配置信息
ContainerFile ContainerFileInfo 容器文件路径信息
ContainerStdout ContainerStdoutInfo 容器标准输出信息
LogType String 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
示例值:minimalist_log
LogFormat String 日志格式化方式
ExtractRule ExtractRuleInfo 提取规则,如果设置了ExtractRule,则必须设置LogType
ExcludePaths.N Array of ExcludePathInfo 采集黑名单路径列表
UserDefineRule String 用户自定义采集规则,Json格式序列化的字符串
Type String 类型:container_stdout、container_file、host_file
示例值:container_stdout
GroupId String 机器组ID
示例值:xxxxx-925b-4cb1-b386-12740a189961
ConfigFlag String 自建采集配置标
示例值:label_k8s
LogsetId String 日志集ID
示例值:xxxxx-925b-4cb1-b386-12740a189961
LogsetName String 日志集name
示例值:xxxxx-925b-4cb1-b386-12740a189961
TopicName String 日志主题name
示例值:xxxxx-925b-4cb1-b386-12740a189961
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 修改特殊采集配置任务

修改特殊采集配置任务

输入示例

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

{
    "ConfigExtraId": "xxxx-xx-xx-xx-xxxxxxxx",
    "Name": "testname",
    "TopicId": "xxx-xxx-xxx",
    "Type": "host_file",
    "HostFile": {
        "LogPath": "/var/log/tmep",
        "FilePattern": "*.log",
        "CustomLabels": [
            "key1=value1",
            "key=value2"
        ]
    },
    "LogType": "minimalist_log",
    "ExtractRule": {
        "TimeKey": "date",
        "TimeFormat": "%Y-%m-%d %H:%M:%S",
        "Delimiter": "|",
        "LogRegex": ".*",
        "BeginRegex": "^",
        "Keys": [
            "date",
            "",
            "content"
        ],
        "FilterKeyRegex": [
            {
                "Key": "xxx-xxx",
                "Regex": "ssss"
            }
        ],
        "UnMatchLogKey": "testlog",
        "UnMatchUpLoadSwitch": true,
        "Backtracking": -1
    },
    "ExcludePaths": [
        {
            "Type": "xxx-xxx",
            "Value": "xxx-xxx"
        }
    ],
    "UserDefineRule": "xxx-xxx"
}

输出示例

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

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.DbDuplication 数据库唯一键冲突。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。