Configuring Cluster Logs

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	Details: Project ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Project IDs of the account Default value: N/A
cluster_id	Yes	String	Details: Cluster ID. For details about how to obtain the value, see How to Obtain Parameters in the API URI. Constraints: None Options: Cluster IDs Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Details: The request body type or format Constraints: The GET method is not verified. Options: application/json application/json;charset=utf-8 application/x-pem-file multipart/form-data (used when the FormData parameter is present) Default value: N/A
X-Auth-Token	Yes	String	Details: 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. Constraints: None Options: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
ttl_in_days	No	Integer	Definition Storage duration (in days). Constraints N/A Range 0-30 Default Value N/A
log_configs	No	Array of log_configs objects	Definition Detailed information about log configuration items Constraints N/A

**Table 4** log_configs
Parameter	Mandatory	Type	Description
name	No	String	Definition Log type Constraints The value must be kube-apiserver, kube-controller-manager, kube-scheduler, audit, or a system add-on name. Range kube-apiserver: The kube-apiserver logs will be collected. kube-controller-manager: The kube-controller-manager logs will be collected. kube-scheduler: The kube-scheduler logs will be collected. audit: The audit logs will be collected. System add-on name: The system add-on logs will be collected. Default Value N/A
enable	No	Boolean	Definition Whether to enable log collection. Constraints N/A Range true: Log collection is enabled. false: Log collection is disabled. Default Value N/A
type	No	String	Definition Component type. The value can be control, audit, or system-addon. Constraints This parameter is returned only when the component type is system-addon. This parameter must be set to system-addon when the API for configuring cluster logs is used to update parameters and system add-on logs need to be collected. Range control: specifies the logs of the control plane components. audit: specifies the audit logs on the control plane. system-addon: specifies the logs of the system add-ons. Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
ttl_in_days	Integer	Definition Storage duration (in days). Constraints N/A Range 0-30 Default Value N/A
log_configs	Array of log_configs objects	Definition Detailed information about log configuration items Constraints N/A

**Table 6** log_configs
Parameter	Type	Description
name	String	Definition Log type Constraints The value must be kube-apiserver, kube-controller-manager, kube-scheduler, audit, or a system add-on name. Range kube-apiserver: The kube-apiserver logs will be collected. kube-controller-manager: The kube-controller-manager logs will be collected. kube-scheduler: The kube-scheduler logs will be collected. audit: The audit logs will be collected. System add-on name: The system add-on logs will be collected. Default Value N/A
enable	Boolean	Definition Whether to enable log collection. Constraints N/A Range true: Log collection is enabled. false: Log collection is disabled. Default Value N/A
type	String	Definition Component type. The value can be control, audit, or system-addon. Constraints This parameter is returned only when the component type is system-addon. This parameter must be set to system-addon when the API for configuring cluster logs is used to update parameters and system add-on logs need to be collected. Range control: specifies the logs of the control plane components. audit: specifies the audit logs on the control plane. system-addon: specifies the logs of the system add-ons. Default Value N/A

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,
    "type" : "system-addon"
  }, {
    "name" : "coredns",
    "enable" : false,
    "type" : "system-addon"
  }, {
    "name" : "everest",
    "enable" : false,
    "type" : "system-addon"
  } ]
}

Example Responses

Status code: 200

Cluster logs are configured successfully.

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