Obtaining a Cluster's Logging Configurations

Function

This API is used to obtain LTS configurations reported by the cluster components.

URI

GET /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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Component type. Options: control, audit, and system-addon. If this parameter is not specified, all component types will be obtained. control: Logs of the components on the master nodes will be obtained. audit: Audit logs of the master nodes will be obtained. system-addon: Logs of system add-ons will be obtained.

Request Parameters

**Table 3** 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.

Response Parameters

Status code: 200

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

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

Example Requests

The following example describes how to obtain add-on log configurations.

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

Example Responses

Status code: 200

Cluster log configurations are obtained successfully.

{
  "log_configs" : [ {
    "name" : "volcano",
    "enable" : true
  }, {
    "name" : "coredns",
    "enable" : false
  }, {
    "name" : "everest",
    "enable" : false
  } ]
}