获取特殊采集配置
最近更新时间: 2026-09-17 00:06:37
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于获取特殊采集配置，特殊采集配置应用于自建K8S环境的采集Agent
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-30 00:44:47。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeConfigExtras |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Filters | 否 | 否 | Array of Filter | 过滤器，支持如下选项： name 按照【特殊采集配置名称】进行模糊匹配过滤。 类型：String configExtraId 按照【特殊采集配置ID】进行过滤。 类型：String topicId 按照【日志主题】进行过滤。 类型：String machineGroupId 按照【机器组ID】进行过滤。 类型：String 每次请求的Filters的上限为10，Filter.Values的上限为5。 示例值：查看 |
| Offset | 否 | 否 | Uint64 | 分页的偏移量，默认值为0 示例值： 0 |
| Limit | 否 | 否 | Uint64 | 分页单页的限制数目，默认值为20，最大值100 示例值： 10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Configs | Array of ConfigExtraInfo | 采集配置列表 示例值：查看 |
| TotalCount | Uint64 | 过滤到的总数目 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |
5. 示例
示例1 获取特殊采集配置
获取特殊采集配置
输入示例
POST / HTTP/1.1
Host: cls.api.com
Content-Type: application/json
X-TC-Action: DescribeConfigExtras
<公共请求参数>
{
"Filters":[{
"Key":"configExtraId",
"Values":["dfa4ac24-caa1-4e30-a027-349cb29937c4"]
}
],
"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": "",
"ContainerFlag": 0,
"CustomLabels": null,
"ExcludeLabels": null,
"ExcludeNamespace": "",
"FilePaths": [],
"FilePattern": "",
"IncludeLabels": null,
"LogPath": "",
"Namespace": "",
"WorkLoad": {
"Container": "",
"ContainerFlag": 0,
"Kind": "",
"Name": "",
"Namespace": ""
}
},
"ContainerStdout": {
"AllContainers": true,
"Container": "",
"ContainerFlag": 0,
"CustomLabels": null,
"ExcludeLabels": null,
"ExcludeNamespace": "",
"IncludeLabels": null,
"Namespace": "name_1",
"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,
"FilePaths": [],
"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
}
}