1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于创建特殊采集配置任务
默认接口请求频率限制：20次/秒。
接口更新时间：2025-08-14 10:43:17。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateConfigExtra |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Name | 是 | 否 | String | 采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾 示例值： configname |
| TopicId | 是 | 否 | String | 日志主题id 示例值： 3269961d-52e0-407b-9dcd-34bd830c6f19 |
| Type | 是 | 否 | String | 日志源类型。支持 container_stdout：容器标准输出；container_file：容器文件路径；host_file：节点文件路径。 示例值： container_stdout |
| HostFile | 否 | 否 | HostFileInfo | 节点文件路径类型配置。 示例值：查看 |
| ContainerFile | 否 | 否 | ContainerFileInfo | 容器文件路径类型配置。 示例值：查看 |
| ContainerStdout | 否 | 否 | ContainerStdoutInfo | 容器标准输出类型配置。 示例值：查看 |
| LogType | 是 | 否 | String | 采集的日志类型，默认为minimalist_log。支持以下类型： json_log代表：JSON-文件日志（详见使用 JSON 提取模式采集日志）； delimiter_log代表：分隔符-文件日志（详见使用分隔符提取模式采集日志）； minimalist_log代表：单行全文-文件日志（详见使用单行全文提取模式采集日志）； fullregex_log代表：单行完全正则-文件日志（详见使用单行-完全正则提取模式采集日志）； multiline_log代表：多行全文-文件日志（详见使用多行全文提取模式采集日志）； multiline_fullregex_log代表：多行完全正则-文件日志（详见使用多行-完全正则提取模式采集日志）； user_define_log代表：组合解析（适用于多格式嵌套的日志，详见使用组合解析提取模式采集日志）。 示例值： minimalist_log |
| LogFormat | 否 | 否 | String | 日志格式化方式，用于容器采集场景。 - 已废弃 stdout-docker-json：用于docker容器采集场景 stdout-containerd：用于containerd容器采集场景 示例值： stdout-containerd |
| ExtractRule | 否 | 否 | ExtractRuleInfo | 提取规则，如果设置了ExtractRule，则必须设置LogType 示例值：查看 |
| ExcludePaths | 否 | 否 | Array of ExcludePathInfo | 采集黑名单路径列表 示例值：查看 |
| UserDefineRule | 否 | 否 | String | 组合解析采集规则，用于复杂场景下的日志采集。 取值参考：使用组合解析提取模式采集日志 示例值： rule |
| GroupId | 否 | 否 | String | 绑定的机器组id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002 |
| ConfigFlag | 是 | 否 | String | 采集配置标记。 目前只支持label_k8s，用于标记自建k8s集群使用的采集配置 示例值： label_k8s |
| LogsetId | 是 | 否 | String | 日志集id 示例值： 57f5808c-4a55-11eb-b378-0242ac130002 |
| LogsetName | 是 | 否 | String | 日志集name 示例值： name1 |
| TopicName | 是 | 否 | String | 日志主题名称 示例值： name2 |
| GroupIds | 否 | 否 | Array of String | 绑定的机器组id列表 示例值： ["59b6014b-6507-44c2-9d4f-a5bee6df9ab5","0af7e6bb-fc91-4ee8-ad24-1129e9c91c6c"] |
| CollectInfos | 否 | 否 | Array of CollectInfo | 采集相关配置信息。详情见CollectInfo复杂类型配置。 示例值：查看 |
| AdvancedConfig | 否 | 否 | String | 高级采集配置。 Json字符串， Key/Value定义为如下： ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false ClsAgentDefault(自定义默认值，无特殊含义，用于清空其他选项)，建议取值0 示例值： config |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConfigExtraId | String | 采集配置扩展信息ID 示例值： 6ef60bec-0242-43af-bb20-270359fb54a8 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |