Configuring Cluster Logs

Updated on 2024-03-22 GMT+08:00

View PDF

Function

This API is used to select the master node components whose logs are reported to LTS.

URI

PUT /api/v3/projects/{project_id}/cluster/{cluster_id}/log-configs

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.
cluster_id	Yes	String	Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ttl_in_days	No	Integer	Time for storage
log_configs	No	Array of log_configs objects	Log configuration items

**Table 4** log_configs
Parameter	Mandatory	Type	Description
name	No	String	Log type
enable	No	Boolean	Whether to collect logs.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
ttl_in_days	Integer	Time for storage
log_configs	Array of log_configs objects	Log configuration items

**Table 6** log_configs
Parameter	Type	Description
name	String	Log type
enable	Boolean	Whether to collect logs.

Example Requests

The following example describes how to configure cluster logs that are reported to LTS.

/api/v3/projects/{project_id}/cluster/{cluster_id}/log-configs

{
  "log_configs" : [ {
    "name" : "kube-apiserver",
    "enable" : true
  }, {
    "name" : "kube-controller-manager",
    "enable" : false
  }, {
    "name" : "kube-scheduler",
    "enable" : false
  }, {
    "name" : "volcano",
    "enable" : true
  }, {
    "name" : "coredns",
    "enable" : false
  }, {
    "name" : "everest",
    "enable" : false
  } ]
}

Example Responses

Status code: 200

Cluster logs are configured successfully.

{
  "ttl_in_days" : 7,
  "log_configs" : [ {
    "name" : "kube-controller-manager",
    "enable" : true
  }, {
    "name" : "kube-apiserver",
    "enable" : true
  }, {
    "name" : "kube-scheduler",
    "enable" : true
  }, {
    "name" : "audit",
    "enable" : true
  } ]
}