1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
查询日志采集规则
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLogConfigs。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterId | 是 | String | 集群ID 示例值:cls-kaftesta |
ClusterType | 否 | String | 当前集群类型支持tke、eks。默认为tke 示例值:tke |
LogConfigNames | 否 | String | 按照采集规则名称查找,多个采集规则使用 "," 分隔。 示例值:configtest1,configtest2 |
Offset | 否 | Integer | 偏移量,默认0 示例值:0 |
Limit | 否 | Integer | 最大输出条数,默认20,最大为100 示例值:10 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 分页查找时返回采集规则总数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
Message | String | 指定采集规则名称查找,部分失败时返回失败采集规则名称及最后一个失败原因 注意:此字段可能返回 null,表示取不到有效值。 示例值:success |
LogConfigs | String | 采集规则查询结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"ItemCount":0,"Items":[]} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询采集规则
查询采集规则
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogConfigs
<公共请求参数>
{
"ClusterId": "cls-bz7ge4wl"
}
输出示例
{
"Response": {
"RequestId": "583e6c4b-ff24-42f8-87f1-37e4c00d81b7",
"Total": 1,
"LogConfigs": "{\"ItemCount\":1,\"Items\":[{\"apiVersion\":\"cls.cloud.tencent.com/v1\",\"kind\":\"LogConfig\",\"metadata\":{\"name\":\"test1\"},\"spec\":{\"clsDetail\":{\"extractRule\":{\"backtracking\":\"0\",\"isGBK\":\"false\",\"jsonStandard\":\"false\",\"unMatchUpload\":\"false\"},\"indexs\":[{\"indexName\":\"namespace\"},{\"indexName\":\"pod_name\"},{\"indexName\":\"container_name\"}],\"logFormat\":\"default\",\"logType\":\"minimalist_log\",\"maxSplitPartitions\":0,\"period\":30,\"region\":\"ap-chengdu\",\"storageType\":\"\",\"topicId\":\"2912eb16-a56c-4b9b-adb0-9828db1ad342\"},\"inputDetail\":{\"containerStdout\":{\"containerOperator\":\"in\",\"includeLabels\":{\"app\":\"test1\"},\"metadataContainer\":[\"namespace\",\"pod_name\",\"pod_ip\",\"pod_uid\",\"container_id\",\"container_name\",\"image_name\",\"cluster_id\"],\"namespace\":\"default\",\"nsLabelSelector\":\"\"},\"type\":\"container_stdout\"},\"kafkaDetail\":{\"brokers\":\"\",\"instanceId\":\"\",\"kafkaType\":\"\",\"logType\":\"\",\"messageKey\":{\"value\":\"\",\"valueFrom\":{\"fieldRef\":{\"fieldPath\":\"\"}}},\"metadata\":{},\"timestampFormat\":\"\",\"timestampKey\":\"\",\"topic\":\"\"}},\"status\":{\"code\":\"success\",\"reason\":\"success\",\"status\":\"Synced\"}}]}"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.KubernetesClientBuildError | Kubernetes client建立失败。 |
FailedOperation.KubernetesGetOperationError | 获取Kubernetes资源失败。 |
FailedOperation.KubernetesListOperationError | 获取Kubernetes资源列表失败。 |
FailedOperation.KubernetesResourceNotFound | Kubernetes没有找到。 |
FailedOperation.Param | 参数错误。 |
InvalidParameter.Param | 参数错误。 |