Help Center/ Cloud Container Engine_Autopilot/ API Reference/ APIs/ Cluster Management (Autopilot)/ Obtaining Cluster Log Configurations
Updated on 2025-11-20 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Cluster Log Configurations

Function

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

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /autopilot/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
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

type

No

String

Definition

Component type. If this parameter is not specified, all component types will be obtained.

Constraints

The value can be control, audit, or system-addon.

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

None

Request Parameters

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

ttl_in_days

Integer

Storage duration.

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 enable log collection.

Example Requests

Obtaining add-on log configurations

/autopilot/v3/projects/{project_id}/cluster/{cluster_id}/log-configs?type=system-addon

Example Responses

Status code: 200

Cluster log configurations are obtained successfully.

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

Status Codes

Status Code

Description

200

Cluster log configurations are obtained successfully.

Error Codes

See Error Codes.

Parent Topic: Cluster Management (Autopilot)