All Products
Search

This Product

    Container Service for Kubernetes:UpdateControlPlaneLog

    Document Center

    Container Service for Kubernetes:UpdateControlPlaneLog

    Last Updated:Aug 28, 2026

    Modifies the log configurations of control plane components. The configurations include the log retention period and components whose logs that you want to collect. 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-apiserver, kube-scheduler, Kubernetes controller manager, and cloud controller manager (CCM).

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cs:UpdateControlPlaneLog

    update

    *Cluster

    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    • cs:EnableCoreControlPlaneComponentsLog
    		 None

    Request syntax

    PUT /clusters/{ClusterId}/controlplanelog HTTP/1.1

    Path Parameters

    Parameter

    Type

    Required

    Description

    Example
    ClusterId

    string

    Yes

    The cluster ID.

    c5b5e80b0b64a4bf6939d2d8fbbc5****

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    body

    object

    No

    The request parameters.

    log_project

    string

    No

    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_ttl

    string

    No

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

    Default value: 30.

    30
    aliuid

    string

    No

    The ID of the Alibaba Cloud account.

    162981*****
    components

    array

    No

    The control plane components for which you want to enable log collection.

    string

    No

    The control plane components for which you want to enable log collection. The following control plane components are supported:

    • apiserver

    • ccm

    • scheduler

    • kcm

    • controlplane-events

    • vk: supported only in Serverless Kubernetes (ASK) clusters.

    • istio: supported only in clusters that are associated with Service Mesh (ASM) instances.

    • cluster-operator: supported only in clusters that are managed by using Distributed Cloud Container Platform for Kubernetes (ACK One).

    • application-controller: supported only in clusters that are managed by using ACK One. By default, log collection is enabled for the following control plane components: apiserver, ccm, scheduler, kcm, and controlplane-events.

    [ "apiserver", "kcm", "scheduler", "ccm", "alb", "controlplane-events", "ack-goatscaler"]

    • UpdateControlPlaneLog 支持仅修改日志存储时间（log_ttl），如果您只在请求体中定义 log_ttl，后台会判定为仅修改存储时间。

    • UpdateControlPlaneLog 支持通过将 components 字段声明为空列表的方式来关闭所有控制面组件的日志。请在请求体中明确将 components 字段声明为空列表，如果不定义 components，将不会触发关闭控制面组件日志的操作。

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    cluster_id

    string

    The cluster ID.

    cb95aa626a47740afbf6aa099b650****
    request_id

    string

    The request ID.

    687C5BAA-D103-4993-884B-C35E4314****
    task_id

    string

    The task ID.

    T-5a54309c80282e39ea00****

    Examples

    Success response

    JSON format

    {
  "cluster_id": "cb95aa626a47740afbf6aa099b650****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314****",
  "task_id": "T-5a54309c80282e39ea00****"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.