CheckControlPlaneLogEnable - Container Service for Kubernetes

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cs:CheckControlPlaneLogEnable	get	*Cluster `acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}`	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	c5b5e80b0b64a4bf6939d2d8fbbc5****

Response parameters

Parameter	Type	Description	Example
	object
log_project	string	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	The retention period of the log data stored in the Logstore. Valid values: 1 to 3000. Unit: days. Default value: 30.	30
aliuid	string	The ID of the Alibaba Cloud account to which the resource belongs.	162981*****
components	array	The control plane components for which log collection is enabled.
components	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.

Change history

Change time	Summary of changes	Operation

No change history