更新时间:2025-12-30 GMT+08:00

配置集群日志

功能介绍

用户可以选择集群管理节点上哪些组件的日志上报LTS

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

账号的项目ID

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID,获取方式请参见如何获取接口URI中参数

约束限制:

不涉及

取值范围:

集群ID

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)

约束限制:

GET方法不做校验

取值范围:

  • application/json

  • application/json;charset=utf-8

  • application/x-pem-file

  • multipart/form-data(注:存在FormData参数时使用)

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

ttl_in_days

Integer

参数解释

存储时长,单位:天。

约束限制

不涉及

取值范围

0-30

默认取值

不涉及

log_configs

Array of log_configs objects

参数解释

日志配置项详细信息

约束限制:

不涉及

表4 log_configs

参数

是否必选

参数类型

描述

name

String

参数解释

日志类型

约束限制

必须为 kube-apiserverkube-controller-managerkube-scheduleraudit 或者系统插件名称

取值范围

  • kube-apiserver:采集kube-apiserver组件日志

  • kube-controller-manager:采集kube-controller-manager日志

  • kube-scheduler:采集kube-scheduler日志

  • audit:采集审计日志

  • 系统插件名称:采集插件日志

默认取值

不涉及

enable

Boolean

参数解释

是否采集

约束限制

不涉及

取值范围

  • true:开启日志采集

  • false:关闭采集日志

默认取值

不涉及

type

String

参数解释

组件类型 , 合法取值为control,audit,system-addon。

约束限制

  • 仅组件类型为系统插件类型时返回该参数

  • 作为配置集群日志接口更新参数时,如果要采集系统插件日志则必须声明为system-addon

取值范围

  • control: 控制面组件日志。

  • audit: 控制面审计日志。

  • system-addon: 系统插件日志。

默认取值

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

ttl_in_days

Integer

参数解释

存储时长,单位:天。

约束限制

不涉及

取值范围

0-30

默认取值

不涉及

log_configs

Array of log_configs objects

参数解释

日志配置项详细信息

约束限制:

不涉及

表6 log_configs

参数

参数类型

描述

name

String

参数解释

日志类型

约束限制

必须为 kube-apiserverkube-controller-managerkube-scheduleraudit 或者系统插件名称

取值范围

  • kube-apiserver:采集kube-apiserver组件日志

  • kube-controller-manager:采集kube-controller-manager日志

  • kube-scheduler:采集kube-scheduler日志

  • audit:采集审计日志

  • 系统插件名称:采集插件日志

默认取值

不涉及

enable

Boolean

参数解释

是否采集

约束限制

不涉及

取值范围

  • true:开启日志采集

  • false:关闭采集日志

默认取值

不涉及

type

String

参数解释

组件类型 , 合法取值为control,audit,system-addon。

约束限制

  • 仅组件类型为系统插件类型时返回该参数

  • 作为配置集群日志接口更新参数时,如果要采集系统插件日志则必须声明为system-addon

取值范围

  • control: 控制面组件日志。

  • audit: 控制面审计日志。

  • system-addon: 系统插件日志。

默认取值

不涉及

请求示例

配置集群日志上报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"
  } ]
}

响应示例

状态码:200

表示集群日志配置成功

{
  "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"
  } ]
}

状态码

状态码

描述

200

表示集群日志配置成功

错误码

请参见错误码