Configuring Cluster Logs

Function

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

Calling Method

For details, see Calling APIs.

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	Definition Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints GET requests are not validated. 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"
  } ]
}

Status Codes

Status Code	Description
200	Cluster logs are configured successfully.

Error Codes

See Error Codes.

Parent topic: Cluster Management

Previous topic: Obtaining a Cluster's Logging Configurations

Next topic: Obtaining the Partition List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot