# 配置集群日志 - UpdateClusterLogConfig #### 功能介绍 用户可以选择集群管理节点上哪些组件的日志上报LTS #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cce/cce_02_0099.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cce/cce_02_0395.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI PUT /api/v3/projects/{project_id}/cluster/{cluster_id}/log-configs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 账号的项目ID **默认取值：** 不涉及 | | cluster_id | 是 | String | **参数解释：** 集群ID，获取方式请参见[如何获取接口URI中参数](https://support.huaweicloud.com/api-cce/cce_02_0271.html)。 **约束限制：** 不涉及 **取值范围：** 集群ID **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式），默认为application/json，有其他取值时会在具体接口中专门说明。 **约束限制：** GET方法不做校验 **取值范围：** 不涉及 **默认取值：** 不涉及 | | X-Auth-Token | 是 | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见[获取token](https://support.huaweicloud.com/api-cce/cce_02_0004.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ttl_in_days | 否 | Integer | **参数解释**： 存储时长，单位：天。 **约束限制**： 不涉及 **取值范围**： 0-30 **默认取值**： 不涉及 | | log_configs | 否 | Array of [log_configs] objects | **参数解释**： 日志配置项详细信息 **约束限制**: 不涉及 | 表4log_configs | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 日志类型 **约束限制**： 必须为 **kube-apiserver** 、**kube-controller-manager** 、**kube-scheduler** 、**audit** 或者系统插件名称 **取值范围**： - 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 | **参数解释**： 日志配置项详细信息 | 表6log_configs | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**： 日志类型 **kube-apiserver** 、**kube-controller-manager** 、**kube-scheduler** 、**audit** 或者系统插件名称 **取值范围**： - 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" } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 配置集群日志上报LTS ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cce.v3.region.CceRegion; import com.huaweicloud.sdk.cce.v3.*; import com.huaweicloud.sdk.cce.v3.model.*; import java.util.List; import java.util.ArrayList; public class UpdateClusterLogConfigSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CceClient client = CceClient.newBuilder() .withCredential(auth) .withRegion(CceRegion.valueOf("")) .build(); UpdateClusterLogConfigRequest request = new UpdateClusterLogConfigRequest(); request.withClusterId("{cluster_id}"); ClusterLogConfig body = new ClusterLogConfig(); List listbodyLogConfigs = new ArrayList<>(); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("kube-apiserver") .withEnable(true) ); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("kube-controller-manager") .withEnable(false) ); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("kube-scheduler") .withEnable(false) ); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("volcano") .withEnable(true) .withType(ClusterLogConfigLogConfigs.TypeEnum.fromValue("system-addon")) ); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("coredns") .withEnable(false) .withType(ClusterLogConfigLogConfigs.TypeEnum.fromValue("system-addon")) ); listbodyLogConfigs.add( new ClusterLogConfigLogConfigs() .withName("everest") .withEnable(false) .withType(ClusterLogConfigLogConfigs.TypeEnum.fromValue("system-addon")) ); body.withLogConfigs(listbodyLogConfigs); request.withBody(body); try { UpdateClusterLogConfigResponse response = client.updateClusterLogConfig(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 配置集群日志上报LTS ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcce.v3.region.cce_region import CceRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcce.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CceClient.new_builder() \ .with_credentials(credentials) \ .with_region(CceRegion.value_of("")) \ .build() try: request = UpdateClusterLogConfigRequest() request.cluster_id = "{cluster_id}" listLogConfigsbody = [ ClusterLogConfigLogConfigs( name="kube-apiserver", enable=True ), ClusterLogConfigLogConfigs( name="kube-controller-manager", enable=False ), ClusterLogConfigLogConfigs( name="kube-scheduler", enable=False ), ClusterLogConfigLogConfigs( name="volcano", enable=True, type="system-addon" ), ClusterLogConfigLogConfigs( name="coredns", enable=False, type="system-addon" ), ClusterLogConfigLogConfigs( name="everest", enable=False, type="system-addon" ) ] request.body = ClusterLogConfig( log_configs=listLogConfigsbody ) response = client.update_cluster_log_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 配置集群日志上报LTS ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cce "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cce/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cce.CceClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cce.NewCceClient(hcClient) request := &model.UpdateClusterLogConfigRequest{} request.ClusterId = "{cluster_id}" nameLogConfigs:= "kube-apiserver" enableLogConfigs:= true nameLogConfigs1:= "kube-controller-manager" enableLogConfigs1:= false nameLogConfigs2:= "kube-scheduler" enableLogConfigs2:= false nameLogConfigs3:= "volcano" enableLogConfigs3:= true typeLogConfigs:= model.GetClusterLogConfigLogConfigsTypeEnum().SYSTEM_ADDON nameLogConfigs4:= "coredns" enableLogConfigs4:= false typeLogConfigs1:= model.GetClusterLogConfigLogConfigsTypeEnum().SYSTEM_ADDON nameLogConfigs5:= "everest" enableLogConfigs5:= false typeLogConfigs2:= model.GetClusterLogConfigLogConfigsTypeEnum().SYSTEM_ADDON var listLogConfigsbody = []model.ClusterLogConfigLogConfigs{ { Name: &nameLogConfigs, Enable: &enableLogConfigs, }, { Name: &nameLogConfigs1, Enable: &enableLogConfigs1, }, { Name: &nameLogConfigs2, Enable: &enableLogConfigs2, }, { Name: &nameLogConfigs3, Enable: &enableLogConfigs3, Type: &typeLogConfigs, }, { Name: &nameLogConfigs4, Enable: &enableLogConfigs4, Type: &typeLogConfigs1, }, { Name: &nameLogConfigs5, Enable: &enableLogConfigs5, Type: &typeLogConfigs2, }, } request.Body = &model.ClusterLogConfig{ LogConfigs: &listLogConfigsbody, } response, err := client.UpdateClusterLogConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCE/sdk?api=UpdateClusterLogConfig)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 表示集群日志配置成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cce/ErrorCode.html)。