All Products
Search
Document Center

Container Service for Kubernetes:CheckControlPlaneLogEnable

Last Updated:Apr 22, 2024

Queries the current log configuration of control plane components, including the log retention period and the log collection component. Container Service for Kubernetes (ACK) managed clusters can collect the logs of control plane components and deliver the logs to projects in Simple Log Service. These control plane components include Kube API Server, Kube Scheduler, Kube Controller Manager, and Cloud Controller Manager.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /clusters/{ClusterId}/controlplanelog

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c5b5e80b0b64a4bf6939d2d8fbbc5****

Response parameters

ParameterTypeDescriptionExample
object
log_projectstring

The name of the Simple Log Service project that you want to use to store the logs of control plane components.

Default value: k8s-log-$Cluster ID.

k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****
log_ttlstring

The retention period of the log data stored in the Logstore. Valid values: 1 to 3000. Unit: days.

Default value: 30.

30
aliuidstring

The ID of the Alibaba Cloud account to which the resource belongs.

162981*****
componentsarray

The control plane components for which log collection is enabled.

string

The control plane components for which log collection is enabled.

By default, log collection is enabled for the following control plane components: apiserver, ccm, scheduler, kcm, and controlplane-events.

["apiserver", "ccm", "scheduler", "kcm", "controlplane-events"]

Examples

Sample success responses

JSONformat

{
  "log_project": "k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****",
  "log_ttl": "30",
  "aliuid": "162981*****",
  "components": [
    "[\"apiserver\", \"ccm\", \"scheduler\",  \"kcm\", \"controlplane-events\"]"
  ]
}

Error codes

For a list of error codes, visit the Service error codes.