1. 接口描述
接口请求域名: tke.tencentcloudapi.com 。
查询集群日志(审计、事件、普通日志)开关列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeLogSwitches。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ClusterIds.N | 是 | Array of String | 集群ID列表 示例值:["cls-e55paxnt"] |
ClusterType | 否 | String | 集群类型,tke 或eks 示例值:tke |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SwitchSet | Array of Switch | 集群日志开关集合 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询开关列表接口示例
获取容器日志组件开关信息
输入示例
POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogSwitches
<公共请求参数>
{
"ClusterType": "tke",
"ClusterIds": [
"cls-dpla09lf",
"cls-oh0o9d8f",
"cls-9r7hfd5h"
]
}
输出示例
{
"Response": {
"RequestId": "bd5b2352-8900-4ab7-b79b-2f51f2e92c26",
"SwitchSet": [
{
"Audit": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
},
"ClusterId": "cls-oh0o9d8f",
"Event": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
},
"Log": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
},
"MasterLog": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
}
},
{
"Audit": {
"Enable": true,
"LogsetId": "d12706e7-ae3b-42cf-9dab-d41e71482193",
"TopicId": "77b6130b-81cf-46dc-9faf-8d4b5afca77f",
"TopicRegion": "ap-chengdu",
"UpgradeAble": false,
"Version": ""
},
"ClusterId": "cls-dpla09lf",
"Event": {
"Enable": true,
"LogsetId": "d12706e7-ae3b-42cf-9dab-d41e71482193",
"TopicId": "ec5a1f8e-5234-419b-bf10-e5789e325bdf",
"TopicRegion": "ap-chengdu",
"UpgradeAble": false,
"Version": ""
},
"Log": {
"Enable": true,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": "1.1.14"
},
"MasterLog": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
}
},
{
"Audit": {
"Enable": true,
"LogsetId": "299ec2db-8139-4f4c-8f83-6022e427df65",
"TopicId": "72d439f2-befa-47cb-924b-39c2d7a64d0b",
"TopicRegion": "ap-chengdu",
"UpgradeAble": false,
"Version": ""
},
"ClusterId": "cls-9r7hfd5h",
"Event": {
"Enable": true,
"LogsetId": "299ec2db-8139-4f4c-8f83-6022e427df65",
"TopicId": "20408e26-932a-4400-a0c8-c5874669265b",
"TopicRegion": "ap-chengdu",
"UpgradeAble": false,
"Version": ""
},
"Log": {
"Enable": true,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": "1.1.14"
},
"MasterLog": {
"Enable": false,
"LogsetId": "",
"TopicId": "",
"TopicRegion": "",
"UpgradeAble": false,
"Version": ""
}
}
]
}
}
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 | 操作失败。 |
FailedOperation.ComponentClientUnpack | 内部HTTP解包失败。 |
FailedOperation.KubernetesListOperationError | 获取Kubernetes资源列表失败。 |
FailedOperation.RBACForbidden | 子账户RBAC权限不足。 |
InternalError | 内部错误。 |
InternalError.KubernetesClientBuildError | kubernetes client建立失败。 |
InternalError.KubernetesGetOperationError | 获取Kubernetes资源失败。 |
InternalError.Param | Param。 |
InternalError.UnexceptedInternal | 内部错误。 |
InternalError.UnexpectedInternal | 未知的内部错误。 |