DescribeControlPlaneLogs

Last updated: 2025-12-29 11:24:22

DescribeControlPlaneLogs

Last updated: 2025-12-29 11:24:22

1. API Description

Domain name for API request: tke.intl.tencentcloudapi.com.

This API is used to query plug-in log collection settings.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeControlPlaneLogs.
Version	Yes	String	Common Params. The value used for this API: 2018-05-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
ClusterId	Yes	String	Cluster ID
ClusterType	Yes	String	Cluster type. currently only support tke.

3. Output Parameters

Parameter Name	Type	Description
Details	Array of ComponentLogConfig	Specifies the query result of log collection configuration.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Plug-In Log Collection Settings

This example shows you how to call when querying plug-in log collection settings.

Input Example

POST / HTTP/1.1
Host: tke.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeControlPlaneLogs
<Common request parameters>

{
    "ClusterId": "cls-kaftesta",
    "ClusterType": "tke"
}

Output Example

{
    "Response": {
        "Details": [
            {
                "Name": "karpenter",
                "LogLevel": 2,
                "LogSetId": "2912eb16-a56c-4b9b-adb0-9828db1ad342",
                "TopicRegion": "ap-guangzhou",
                "TopicId": "2912eb16-a56c-4b9b-adb0-9828db1ad342"
            }
        ],
        "RequestId": "583e6c4b-ff24-42f8-87f1-37e4c00d81b7"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.ClusterNotFound	The cluster is not found.
FailedOperation.KubernetesClientBuildError	Failed to create the Kubernetes client.
FailedOperation.KubernetesGetOperationError	Failed to get Kubernetes resources.
FailedOperation.KubernetesListOperationError	Failed to obtain the kubernetes resource list.
FailedOperation.KubernetesResourceNotFound	Kubernetes is not found.
InvalidParameter.Param	Parameter error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud