创建特殊采集配置任务
最近更新时间: 2024-10-18 10:38:40
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
本接口用于创建特殊采集配置任务
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateConfigExtra |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Name | 是 | 否 | String | 采集配置规程名称，最长63个字符，只能包含小写字符、数字及分隔符（“-”），且必须以小写字符开头，数字或小写字符结尾 |
| TopicId | 是 | 否 | String | 日志主题id |
| Type | 是 | 否 | String | 类型：container_stdout、container_file、host_file |
| HostFile | 否 | 否 | HostFileInfo | 节点文件配置信息 |
| ContainerFile | 否 | 否 | ContainerFileInfo | 容器文件路径信息 |
| ContainerStdout | 否 | 否 | ContainerStdoutInfo | 容器标准输出信息 |
| LogType | 是 | 否 | String | 采集的日志类型，json_log代表json格式日志，delimiter_log代表分隔符格式日志，minimalist_log代表极简日志，multiline_log代表多行日志，fullregex_log代表完整正则，默认为minimalist_log |
| LogFormat | 否 | 否 | String | 日志格式化方式 |
| ExtractRule | 否 | 否 | ExtractRuleInfo | 提取规则，如果设置了ExtractRule，则必须设置LogType |
| ExcludePaths | 否 | 否 | Array of ExcludePathInfo | 采集黑名单路径列表 |
| UserDefineRule | 否 | 否 | String | 用户自定义采集规则，Json格式序列化的字符串 |
| GroupId | 是 | 否 | String | 绑定的机器组id |
| ConfigFlag | 是 | 否 | String | 采集配置标 |
| LogsetId | 是 | 否 | String | 日志集id |
| LogsetName | 是 | 否 | String | 日志集name |
| TopicName | 是 | 否 | String | 日志主题名称 |
| GroupIds | 否 | 否 | Array of String | 绑定的机器组id列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConfigExtraId | String | 此参数对外不可见。 采集配置扩展信息ID |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| MissingParameter | |
| InternalError | |
| FailedOperation | |
| AuthFailure | |
| OperationDenied | |
| ResourceNotFound.TopicNotExist | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists |