1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
创建采集规则配置
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-30 00:17:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateConfig |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Name | 是 | 否 | String | 采集配置名称 示例值： config_name |
| LogFormat | 否 | 否 | String | 日志格式化方式 示例值： default |
| Path | 否 | 否 | String | 日志采集路径，包含文件名，支持多个路径，多个路径之间英文逗号分隔，文件采集情况下必填 示例值： /data/access.log |
| LogType | 否 | 否 | String | 采集的日志类型，默认为minimalist_log。支持以下类型： json_log代表：JSON-文件日志（详见使用 JSON 提取模式采集日志）； delimiter_log代表：分隔符-文件日志（详见使用分隔符提取模式采集日志）； minimalist_log代表：单行全文-文件日志（详见使用单行全文提取模式采集日志）； fullregex_log代表：单行完全正则-文件日志（详见使用单行-完全正则提取模式采集日志）； multiline_log代表：多行全文-文件日志（详见使用多行全文提取模式采集日志）； multiline_fullregex_log代表：多行完全正则-文件日志（详见使用多行-完全正则提取模式采集日志）； user_define_log代表：组合解析（适用于多格式嵌套的日志，详见使用组合解析提取模式采集日志）； service_syslog代表：syslog 采集（详见采集 Syslog）； windows_event_log代表：Windows事件日志（详见采集 Windows 事件日志）。 示例值： delimiter_log |
| ExtractRule | 否 | 否 | ExtractRuleInfo | 提取规则，如果设置了ExtractRule，则必须设置LogType 示例值：查看 |
| ExcludePaths | 否 | 否 | Array of ExcludePathInfo | 采集黑名单路径列表 示例值：查看 |
| Output | 是 | 否 | String | 采集配置所属日志主题ID即TopicId 示例值： 57f5808c-4a55-11eb-b378-0242ac130002 |
| UserDefineRule | 否 | 否 | String | 用户自定义采集规则，Json格式序列化的字符串。当LogType为user_define_log时，必填。 示例值： rule |
| ConfigExtraId | 否 | 否 | String | config_extra表主键ID 示例值： 57f5808c-4a55-11eb-b378-0242ac130002 |
| ConfigFlag | 否 | 否 | String | 采集配置标签 示例值： label_k8s |
| AdvancedConfig | 否 | 否 | String | 高级采集配置。 Json字符串， Key/Value定义为如下： ClsAgentFileTimeout(超时属性), 取值范围: 大于等于0的整数， 0为不超时 ClsAgentMaxDepth(最大目录深度)，取值范围: 大于等于0的整数 ClsAgentParseFailMerge(合并解析失败日志)，取值范围: true或false 样例： {"ClsAgentFileTimeout":0,"ClsAgentMaxDepth":10,"ClsAgentParseFailMerge":true} 控制台默认占位值：{"ClsAgentDefault":0} 示例值： config |
| Source | 否 | 否 | Uint64 | 采集配置来源，0：默认来源，1: TKE 示例值： 0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConfigId | String | 采集配置ID 示例值： 48c3ae1f-1e6e-47e7-b08f-5c2507bb6695 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| AuthFailure | CAM签名/鉴权错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound.TopicNotExist | 日志主题不存在。 |
| LimitExceeded.Config | 采集规则配置超过最大值限制。 |
| InvalidParameter.ConfigConflict | 相同的采集配置规则已经存在。 |
| OperationDenied.AccountIsolate | 账户欠费。 |
| OperationDenied.AccountDestroy | 账户已销毁。 |
| OperationDenied.AccountNotExists | 账户不存在。 |