获取特殊采集配置

1. 接口描述

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

本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 获取特殊采集配置

获取特殊采集配置

输入示例

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

{
    "Filters": [
        {
            "Key": "configExtraId",
            "Values": [
                "xxxx-xxx-xxxx"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Configs": [
            {
                "AdvancedConfig": "{\"ClsAgentFileTimeout\":3600}",
                "CollectInfos": [
                    {
                        "CollectConfigs": [
                            {
                                "Name": "container_name"
                            },
                            {
                                "Name": "namespace"
                            },
                            {
                                "Name": "pod_name"
                            },
                            {
                                "Name": "pod_ip"
                            }
                        ],
                        "Type": 0
                    },
                    {
                        "CollectConfigs": [],
                        "Type": 1
                    }
                ],
                "ConfigExtraId": "26ea1681-dfef-4429-a84f-3450d5d46796",
                "ConfigFlag": "label_k8s",
                "ContainerFile": {
                    "Container": "",
                    "CustomLabels": null,
                    "ExcludeLabels": null,
                    "ExcludeNamespace": "",
                    "FilePaths": [],
                    "FilePattern": "",
                    "IncludeLabels": null,
                    "LogPath": "",
                    "Namespace": "",
                    "WorkLoad": {
                        "Container": "",
                        "Kind": "",
                        "Name": "",
                        "Namespace": ""
                    }
                },
                "ContainerStdout": {
                    "AllContainers": true,
                    "Container": "",
                    "CustomLabels": null,
                    "ExcludeLabels": null,
                    "ExcludeNamespace": "",
                    "IncludeLabels": null,
                    "Namespace": "*",
                    "WorkLoads": null
                },
                "CreateTime": "2023-12-04 14:32:35",
                "ExcludePaths": null,
                "ExtractRule": {
                    "Address": "",
                    "AdvanceFilterRules": null,
                    "Backtracking": 0,
                    "BeginRegex": "",
                    "Delimiter": "",
                    "EventLogRules": [],
                    "FilterKeyRegex": [],
                    "IsGBK": 0,
                    "JsonStandard": 0,
                    "Keys": [
                        "__CONTENT__"
                    ],
                    "LogRegex": "",
                    "MetaTags": [],
                    "MetadataType": 0,
                    "ParseProtocol": "",
                    "PathRegex": "",
                    "Protocol": "",
                    "TimeFormat": "",
                    "TimeKey": "",
                    "UnMatchLogKey": null,
                    "UnMatchUpLoadSwitch": false
                },
                "GroupId": "886bf7a8-7340-4314-8d64-b360da0ffd78",
                "HostFile": {
                    "CustomLabels": null,
                    "FilePattern": "",
                    "LogPath": ""
                },
                "LogFormat": "",
                "LogType": "minimalist_log",
                "LogsetId": "40907915-faa6-46e0-985f-b2fa8c17a080",
                "LogsetName": "logset-test",
                "Name": "config-test-886bf7a8-7340-4314-8d64-b360da0ffd78",
                "TopicId": "b2dcf2e5-9582-4c87-9286-cccccb53889d",
                "TopicName": "topic-test",
                "Type": "container_stdout",
                "UpdateTime": "2023-12-04 14:32:34",
                "UserDefineRule": ""
            }
        ],
        "RequestId": "4e48c681-ebf8-4df1-bf0a-51f689117ac6",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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