1. 接口描述
接口请求域名： dlc.tencentcloudapi.com 。
查询指定 TKE 集群是否开启了事件日志。已开启时同时返回关联的 CLS 日志集 ID、日志主题 ID 与主题所在地域。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeClusterEventLogSwitch。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-shanghai, ap-singapore 。 |
| ClusterId | 是 | String | TKE 集群 ID 示例值：cls-882vl2ia |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ClusterId | String | TKE 集群 ID（回显） 示例值：cls-882vl2ia |
| Enable | Boolean | 事件日志是否已开启 示例值：true |
| LogsetId | String | 关联的 CLS 日志集 ID（Enable=true 时返回） 示例值：f6f9e5c2-cdf4-41ad-8c3f-af0cf5e143ba |
| TopicId | String | 关联的 CLS 日志主题 ID（Enable=true 时返回） 示例值：a1dd3c49-1a5f-4d85-800d-bb9bcf5e3294 |
| TopicRegion | String | 关联的 CLS 日志主题所在地域（Enable=true 时返回） 示例值：ap-guangzhou |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 已开启事件日志
已开启事件日志分支
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterEventLogSwitch
<公共请求参数>
{
"ClusterId": "cls-xxxxxxxx"
}输出示例
{
"Response": {
"ClusterId": "cls-xxxxxxxx",
"Enable": true,
"LogsetId": "d12706e7-ae3b-42cf-9dab-d41e71482193",
"TopicId": "ec5a1f8e-5234-419b-bf10-e5789e325bdf",
"TopicRegion": "ap-chengdu",
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}示例2 未开启事件日志
未开启事件日志分支
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterEventLogSwitch
<公共请求参数>
{
"ClusterId": "cls-xxxxxxxx"
}输出示例
{
"Response": {
"ClusterId": "cls-xxxxxxxx",
"Enable": false,
"RequestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ExternalService | 外部服务异常 |
