创建特殊采集配置任务

最近更新时间:2024-05-08 01:12:25

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateConfigExtra。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
Name String 采集配置规程名称,最长63个字符,只能包含小写字符、数字及分隔符(“-”),且必须以小写字符开头,数字或小写字符结尾
示例值:configname
TopicId String 日志主题id
示例值:3269961d-52e0-407b-9dcd-34bd830c6f19
Type String 日志源类型。支持 container_stdout:容器标准输出;container_file:容器文件路径;host_file:节点文件路径。
示例值:container_stdout
LogType String 采集的日志类型,默认为minimalist_log。支持以下类型:
- json_log代表:JSON-文件日志(详见使用 JSON 提取模式采集日志);
- delimiter_log代表:分隔符-文件日志(详见使用分隔符提取模式采集日志);
- minimalist_log代表:单行全文-文件日志(详见使用单行全文提取模式采集日志);
- fullregex_log代表:单行完全正则-文件日志(详见使用单行-完全正则提取模式采集日志);
- multiline_log代表:多行全文-文件日志(详见使用多行全文提取模式采集日志);
- multiline_fullregex_log代表:多行完全正则-文件日志(详见使用多行-完全正则提取模式采集日志);
- user_define_log代表:组合解析(适用于多格式嵌套的日志,详见使用组合解析提取模式采集日志)。
示例值:minimalist_log
ConfigFlag String 采集配置标记。
- 目前只支持label_k8s,用于标记自建k8s集群使用的采集配置

示例值:label_k8s
LogsetId String 日志集id
示例值:57f5808c-4a55-11eb-b378-0242ac130002
LogsetName String 日志集name
示例值:name1
TopicName String 日志主题名称
示例值:name2
HostFile HostFileInfo 节点文件路径类型配置。
ContainerFile ContainerFileInfo 容器文件路径类型配置。
ContainerStdout ContainerStdoutInfo 容器标准输出类型配置。
LogFormat String 日志格式化方式,用于容器采集场景。
- stdout-docker-json:用于docker容器采集场景
- stdout-containerd:用于containerd容器采集场景
ExtractRule ExtractRuleInfo 提取规则,如果设置了ExtractRule,则必须设置LogType
ExcludePaths.N Array of ExcludePathInfo 采集黑名单路径列表
UserDefineRule String 组合解析采集规则,用于复杂场景下的日志采集。
- 取值参考:使用组合解析提取模式采集日志
GroupId String 绑定的机器组id
示例值:57f5808c-4a55-11eb-b378-0242ac130002
GroupIds.N Array of String 绑定的机器组id列表
示例值:["59b6014b-6507-44c2-9d4f-a5bee6df9ab5","0af7e6bb-fc91-4ee8-ad24-1129e9c91c6c"]
CollectInfos.N Array of CollectInfo 采集相关配置信息。详情见CollectInfo复杂类型配置。
AdvancedConfig String 高级采集配置。 Json字符串, Key/Value定义为如下:
- ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数, 0为不超时
- ClsAgentMaxDepth(最大目录深度),取值范围: 大于等于0的整数
- ClsAgentParseFailMerge(合并解析失败日志),取值范围: true或false
- ClsAgentDefault(自定义默认值,无特殊含义,用于清空其他选项),建议取值0

示例值:{"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true}

3. 输出参数

参数名称 类型 描述
ConfigExtraId String 采集配置扩展信息ID
示例值:6ef60bec-0242-43af-bb20-270359fb54a8
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建特殊采集配置任务

创建特殊采集配置任务

输入示例

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

{
    "Name": "configname",
    "TopicId": "3269961d-52e0-407b-9dcd-34bd830c6f19",
    "Type": "host_file",
    "HostFile": {
        "LogPath": "/var/log/tmep",
        "FilePattern": "*.log",
        "CustomLabels": [
            "key1=value1",
            "key2=value2"
        ]
    },
    "LogType": "minimalist_log",
    "ExtractRule": {
        "TimeKey": "date",
        "TimeFormat": "%Y-%m-%d %H:%M:%S",
        "Delimiter": "|",
        "LogRegex": ".*",
        "BeginRegex": "^",
        "Keys": [
            "date",
            "",
            "content"
        ],
        "FilterKeyRegex": [
            {
                "Key": "__CONTENT__",
                "Regex": "400|500"
            }
        ],
        "UnMatchLogKey": "testlog",
        "UnMatchUpLoadSwitch": true,
        "Backtracking": -1
    },
    "ExcludePaths": [
        {
            "Type": "Path",
            "Value": "/var/log1/"
        },
        {
            "Type": "File",
            "Value": "/var/log2/app.log"
        }
    ],
    "UserDefineRule": "",
    "GroupId": "59b6014b-6507-44c2-9d4f-a5bee6df9ab5",
    "ConfigFlag": "label_k8s",
    "LogsetId": "0af7e6bb-fc91-4ee8-ad24-1129e9c91c6c",
    "LogsetName": "name1",
    "TopicName": "name2"
}

输出示例

{
    "Response": {
        "ConfigExtraId": "be923f41-dfbd-4a08-8afc-8b247647ae4b",
        "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.DbDuplication 数据库唯一键冲突。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.TopicNotExist 日志主题不存在。