All Products
Search
Document Center

Container Service for Kubernetes:UpdateControlPlaneLog

Last Updated:Apr 22, 2024

You can call the UpdateControlPlaneLog operation to modify the log collection configurations for control plane components in a Container Service for Kubernetes (ACK) managed cluster.

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

PUT /clusters/{ClusterId}/controlplanelog

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c5b5e80b0b64a4bf6939d2d8fbbc5****
bodyobjectNo

The request body parameters.

log_projectstringNo

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_ttlstringNo

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

Default value: 30.

30
aliuidstringNo

The ID of the Alibaba Cloud account.

162981*****
componentsarrayNo

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

stringNo

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

  • apiserver
  • ccm
  • scheduler
  • kcm
  • vk: supported only in ACK Serverless 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", "ccm", "scheduler", "kcm", "controlplane-events"]

Response parameters

ParameterTypeDescriptionExample
object

The response body.

cluster_idstring

The cluster ID.

cb95aa626a47740afbf6aa099b650****
request_idstring

The request ID.

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

The task ID.

T-5a54309c80282e39ea00****

Examples

Sample success responses

JSONformat

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

Examples

Sample success responses

JSONformat

{
	"cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****",
	"request_id": "A0322123-8DE3-199A-913D-6CBC0F4C****",
	"task_id": "T-65840b469fc9d303b000****"
}

Examples

Sample success responses

JSONformat

{
	"cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****",
	"request_id": "A0322123-8DE3-199A-913D-6CBC0F4C****",
	"task_id": "T-65840b469fc9d303b000****"
}

Examples

Sample success responses

JSONformat

{
	"cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****",
	"request_id": "A0322123-8DE3-199A-913D-6CBC0F4C****",
	"task_id": "T-65840b469fc9d303b000****"
}

Examples

Sample success responses

JSONformat

{
	"cluster_id": "c5b5e80b0b64a4bf6939d2d8fbbc5****",
	"request_id": "A0322123-8DE3-199A-913D-6CBC0F4C****",
	"task_id": "T-65840b469fc9d303b000****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.