创建日志采集配置

最近更新时间:2024-03-12 01:57:17

我的收藏

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

创建日志采集配置

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCLSLogConfig。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
LogConfig String 日志采集配置的json表达
示例值:{"apiVersion":"cls.cloud.tencent.com/v1","kind":"LogConfig","metadata":{"name":"stdout"},"spec":{"clsDetail":{"logType":"minimalist_log","logFormat":"default","topicId":null,"userDefineRule":null,"extractRule":{"timeKey":null,"timeFormat":null,"delimiter":null,"logRegex":null,"beginningRegex":null,"keys":[],"filterKeys":[],"filterRegex":[],"unMatchUpload":"false","unMatchedKey":null,"backtracking":"0"},"topicName":null,"indexs":[],"region":null},"inputDetail":{"type":"container_stdout","containerStdout":{"allContainers":false,"namespace":null,"workloads":[{"namespace":"default","kind":"deployment","name":"stdout","container":""}],"includeLabels":null,"container":null,"metadataLabels":[]},"containerFile":null,"hostFile":null},"kafkaDetail":null}}
ClusterId String 集群ID
示例值:cls-kaftesta
LogsetId String CLS日志集ID
示例值:tas89a94-d952-410a-a393-9224de64test
ClusterType String 当前集群类型支持tke、eks
示例值:tke

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建日志采集规则

创建采集规则是调用

输入示例

https://tke.tencentcloudapi.com/?Action=CreateCLSLogConfig
&LogConfig={\"apiVersion\":\"cls.cloud.tencent.com/v1\",\"kind\":\"LogConfig\",\"metadata\":{\"name\":\"stdout\"},\"spec\":{\"clsDetail\":{\"logType\":\"minimalist_log\",\"logFormat\":\"default\",\"topicId\":null,\"userDefineRule\":null,\"extractRule\":{\"timeKey\":null,\"timeFormat\":null,\"delimiter\":null,\"logRegex\":null,\"beginningRegex\":null,\"keys\":[],\"filterKeys\":[],\"filterRegex\":[],\"unMatchUpload\":\"false\",\"unMatchedKey\":null,\"backtracking\":\"0\"},\"topicName\":null,\"indexs\":[],\"region\":null},\"inputDetail\":{\"type\":\"container_stdout\",\"containerStdout\":{\"allContainers\":false,\"namespace\":null,\"workloads\":[{\"namespace\":\"default\",\"kind\":\"deployment\",\"name\":\"stdout\",\"container\":\"\"}],\"includeLabels\":null,\"container\":null,\"metadataLabels\":[]},\"containerFile\":null,\"hostFile\":null},\"kafkaDetail\":null}}
&ClusterId=cls-kaftesta
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "f12a6e20-f950-4af9-8f8b-b6329a4961c2"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ClusterState 集群状态错误。
FailedOperation.ComponentClientCommon 内部Client错误。
FailedOperation.ComponentClientHttp 内部HTTP客户端错误。
FailedOperation.ComponentClientUnpack 内部HTTP解包失败。
FailedOperation.CreateClsClient 创建CLS客户端失败。
FailedOperation.CreateClsConfig 创建CLS采集配置失败。
FailedOperation.CreateClsIndex 创建CLS索引失败。
FailedOperation.CreateClsLogSet 创建CLS日志集失败。
FailedOperation.CreateClsMachineGroup 创建CLS机器组失败。
FailedOperation.CreateClsTopic 创建 CLS 主题失败。
FailedOperation.GetClsConfig 获取CLS采集配置失败。
FailedOperation.GetClsConfigMachineGroups 获取CLS采集配置绑定的机器组失败。
FailedOperation.GetClsIndex 获取CLS索引配置失败。
FailedOperation.GetClsLogSet 查询主题集失败。
FailedOperation.GetClsMachineGroup 获取CLS机器组失败。
FailedOperation.GetClsMachineGroupConfigs 获取CLS机器组绑定的采集配置失败。
FailedOperation.GetClsTopic 获取CLS日志主题失败。
FailedOperation.K8sClientBuildError Kubernetes client建立失败。
FailedOperation.KubeClientConnection 连接用户Kubernetes集群失败。
FailedOperation.KubeCommon KubernetesAPI错误。
FailedOperation.KubernetesClientBuildError Kubernetes client建立失败。
FailedOperation.KubernetesCreateOperationError 创建集群Client出错。
FailedOperation.KubernetesGetOperationError 获取Kubernetes资源失败。
FailedOperation.KubernetesInternal Kubernetes未知错误。
FailedOperation.ModifyClsConfig 修改CLS采集配置失败。
FailedOperation.ModifyClsIndex 修改CLS索引失败。
FailedOperation.ModifyClsTopic 修改CLS日志主题失败。
InternalError.ComponentClientHttp 内部HTTP客户端错误。
InternalError.ComponentClinetHttp 请求(http请求)其他云服务失败。
InternalError.UnexceptedInternal 内部错误。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.Param 参数错误。