文档首页/ 云日志服务 LTS/ 更多文档/ API参考（联盟区域）/ API/ 日志接入/ 修改日志接入
更新时间：2026-01-05 GMT+08:00
查看PDF
分享

修改日志接入

功能介绍

修改日志接入

URI

PUT /v3/{project_id}/lts/access-config

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见：获取账号租户ID、项目资源集ID、日志组ID、日志流ID。

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

从IAM服务获取的用户Token，获取方式请参见：获取用户Token

最小长度：1000

最大长度：2000

Content-Type

是

String

该字段填为：application/json;charset=UTF-8。

最小长度：30

最大长度：30
表3 请求Body参数

参数

是否必选

参数类型

描述

access_config_id

是

String

日志接入ID

最小长度：36

最大长度：36

access_config_name

否

String

日志接入名称。

只支持输入英文、数字、中文、中划线、下划线及小数点，且不能以小数点、下划线开头或以小数点结尾，长度不超过64。

access_config_detail

否

AccessConfigDeatilCreate object

日志接入详细信息

host_group_info

否

AccessConfigHostGroupIdList object

日志接入主机组ID列表

access_config_tag

否

Array of accessConfigTag objects

标签信息。KEY不能重复,最多20个标签

log_split

否

Boolean

日志拆分

binary_collect

否

Boolean

二进制采集

cluster_id

否

String

CCE集群ID，CCE类型时，为必填

incremental_collect

否

Boolean

是否增量采集 true为是 false为否（全量采集）

encoding_format

否

String

编码格式，默认UTF-8

processor_type

否

String

IC结构化解析类型

demo_log

否

String

示例日志

demo_fields

否

Array of DemoFieldAccess objects

示例日志解析字段

processors

否

Array of Processor objects

ICAgent结构化解析器

application_id

否

String

ServiceStage应用ID

environment_id

否

String

ServiceStage环境ID

component_id

否

Array of strings

ServiceStage组件ID
表4 AccessConfigDeatilCreate

参数

是否必选

参数类型

描述

paths

否

Array of strings

参数解释：

采集路径。

  • 路径必须以/或者字母:\开头。

  • 不能包含特殊字符<> ' | " 且不能只输入/。

  • 第一级目录不支持通配符*：不能以/** /*开头。

  • **只能出现一次``

  • CCE类型中容器路径和主机路径必填，标准输出不用。

black_paths

否

Array of strings

参数解释：

采集黑名单路径。

  • 路径必须以/或者字母:\开头

  • 不能包含特殊字符<> ' | " 且不能只输入/

  • 第一级目录不支持通配符*：不能以/** /*开头

  • **只能出现一次

format

是

AccessConfigFormatCreate object

参数解释：

日志格式相关信息。

windows_log_info

否

AccessConfigWindowsLogInfoCreate object

参数解释：

日志接入配置Windows事件日志相关信息。

stdout

否

Boolean

参数解释：

云容器引擎CCE应用日志接入时，是否开启采集容器标准输出。

取值范围：

  • true：开启采集容器标准输出。

  • false：不开启采集容器标准输出。

stderr

否

Boolean

参数解释：

云容器引擎CCE应用日志接入时，是否开启采集容器标准错误。

取值范围：

  • true：开启采集容器标准错误。

  • false：不开启采集容器标准错误。

pathType

否

String

参数解释：

数据源类型。仅云容器引擎CCE应用日志接入支持。

取值范围：

  • HOST_FILE：节点文件类型

  • CONTAINER_STDOUT：容器标准输出

  • CONTAINER_FILE：容器文件路径

  • K8S_EVENT：K8S事件

namespaceRegex

否

String

参数解释：

K8s Namespace正则匹配。通过Namespace名称指定采集的容器，支持正则匹配。采集名称符合正则规则的Namespace的日志，为空时采集所有Namespace的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

podNameRegex

否

String

参数解释：

K8s Pod正则匹配。通过Pod名称指定待采集的容器，支持正则匹配。采集名称符合正则规则的Pod的日志，为空时采集所有Pod的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

containerNameRegex

否

String

参数解释：

K8s容器名称正则匹配。通过容器名称指定待采集的容器（Kubernetes容器名称是定义在spec.containers中），支持正则匹配。采集名称符合正则规则的容器的日志，为空时采集所有容器的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

includeLabels

否

Map<String,String>

参数解释：

容器Label白名单，云容器引擎CCE应用日志接入时，可通过容器Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都匹配；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeLabels

否

Map<String,String>

参数解释：

容器Label黑名单，云容器引擎CCE应用日志接入时，可通过容器Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都被排除；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

includeEnvs

否

Map<String,String>

参数解释：

环境变量白名单，云容器引擎CCE应用日志接入时，可通过环境变量白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则环境变量中包含LabelKey的容器都匹配；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeEnvs

否

Map<String,String>

参数解释：

环境变量黑名单，云容器引擎CCE应用日志接入时，可通过环境变量黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则环境变量中包含LabelKey的容器都被排除；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

logLabels

否

Map<String,String>

参数解释：

容器 Label日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增容器Label相关字段。例如：设置LabelKey为app，设置LabelValue为app_alias，当容器中包含app=lts时，将在日志中添加内容{app_alias：lts}。

logEnvs

否

Map<String,String>

参数解释：

环境变量日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增环境变量相关字段。例如：设置环境变量Key为app，设置环境变量Value为app_alias，当K8S中包含环境变量app=lts时，将在日志中添加的内容为{app_alias：lts}。

includeK8sLabels

否

Map<String,String>

参数解释：

K8s Label白名单，云容器引擎CCE应用日志接入时，可通过K8s Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都匹配；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeK8sLabels

否

Map<String,String>

参数解释：

K8s Label黑名单，云容器引擎CCE应用日志接入时，可通过K8s Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都被排除；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

logK8s

否

Map<String,String>

参数解释：

K8s Label日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增K8s Label相关字段。例如：设置LabelKey为app，设置LabelValue为app_alias，当容器中包含app=lts时，将在日志中添加内容{app_alias：lts}。

repeat_collect

否

Boolean

参数解释：

是否允许多次采集。

取值范围：

  • true：表示开启，同一主机下的同一日志文件支持被采集到多个日志流。

  • false：表示关闭，采集路径不能重复配置，即同一主机下的同一日志文件，即使跨日志流，也只能配置一次。

system_fields

否

Array of strings

参数解释：

系统内置字段。配置日志接入规则时，可以配置系统内置字段，上报日志后，每条日志数据的标签数据中将会有系统字段。若修改该字段，将覆盖原有配置。

  • 采集场景为主机文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、__host_group__

  • 采集场景为K8S集群容器文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、clusterId、podName、appName、containerName、nameSpace、__host_group__、serviceID、podIp、clusterName、workloadType、__image_name__

custom_key_value

否

Map<String,String>

参数解释：

自定义键值对，格式为Key/Value键值对。配置日志接入规则时，可以配置自定义键值对规则，上报日志后，每条日志数据的标签数据中将会有用户自定义的键值对字段。最多支持创建20个。若修改该字段，将覆盖原有配置。

  • Key：允许的字符有a-zA-Z0-9_-，长度不能超过128个字符。

  • Value：长度不能超过1024个字符。

includeLabelsLogical

否

String

参数解释：

容器 Label白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeLabelsLogical

否

String

参数解释：

容器 Label黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR

includeK8sLabelsLogical

否

String

参数解释：

K8S Label白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeK8sLabelsLogical

否

String

参数解释：

K8S Label黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR

includeEnvsLogical

否

String

参数解释：

环境变量白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeEnvsLogical

否

String

参数解释：

环境变量黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR
表5 AccessConfigFormatCreate

参数

是否必选

参数类型

描述

single

否

AccessConfigFormatSingleCreate object

日志接入格式单行日志

multi

否

AccessConfigFormatMutilCreate object

日志接入格式多行日志
表6 AccessConfigFormatSingleCreate

参数

是否必选

参数类型

描述

mode

否

String

单行日志。system：系统时间，wildcard：时间通配符。

value

否

String

日志时间。当mode为”system”，则填入当前时间戳。当mode为"wildcard"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss
表7 AccessConfigFormatMutilCreate

参数

是否必选

参数类型

描述

mode

否

String

单行日志。time：日志时间，regular：正则模式。

value

否

String

日志时间。当mode为"regular"，则输入正则表达式当mode为"time"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss
表8 AccessConfigWindowsLogInfoCreate

参数

是否必选

参数类型

描述

categorys

是

Array of strings

采集Windows事件日志类型。

  • Application：应用事件日志

  • System：系统事件日志

  • Security：安全事件日志

  • Setup：启动事件日志

time_offset

是

AccessConfigTimeOffset object

首次采集时间偏移量

event_level

是

Array of strings

事件等级。

  • information：表示一般的信息事件，通常不会对系统运行产生影响。

  • warning：表示可能影响系统正常运行的警告事件，但不会导致系统崩溃。

  • error：表示导致系统崩溃或服务无法正常运行的错误事件。

  • critical：表示系统遇到了严重的关键事件，可能导致系统或应用程序的失败。

  • verbose：表示用于记录非常详细的事件信息，这些事件信息通常不会对系统的正常运行产生直接影响。
表9 AccessConfigTimeOffset

参数

是否必选

参数类型

描述

offset

是

Long

偏移时间。

当"unit"选择"day"时，范围为1~7天。

当"unit"选择"hour"时，范围为1~168小时。

当"unit"选择"sec"时，范围为1~604800秒。

unit

是

String

偏移时间单位。

  • day ：天

  • hour：小时

  • sec：秒
表10 AccessConfigHostGroupIdList

参数

是否必选

参数类型

描述

host_group_id_list

是

Array of strings

主机组ID列表
表11 accessConfigTag

参数

是否必选

参数类型

描述

key

是

String

标签Key，不可重复

  • 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。

  • 标签键长度不能超过128个字符。

value

否

String

标签Value

  • 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。

  • 标签值长度不能超过255个字符。
表12 DemoFieldAccess

参数

是否必选

参数类型

描述

field_name

否

String

参数解释：

示例日志解析字段。

取值范围：

不涉及。

field_value

否

String

参数解释：

示例日志的字段的值。

取值范围：

不涉及。
表13 Processor

参数

是否必选

参数类型

描述

type

否

String

参数解释：

结构化解析类型，有以下七种：

  • processor_regex：正则解析。

  • processor_split_string：分词符。

  • processor_json：json解析类型。

  • processor_gotime：自定义时间类型。

  • processor_filter_regex：日志过滤。

  • processor_drop：删除字段类型。

  • processor_rename：修改字段类型。

取值范围：

不涉及。

detail

否

Detail object

参数解释：

结构化解析配置的相关信息。
表14 Detail

参数

是否必选

参数类型

描述

source_key

否

String

参数解释：

原始字段。日志结构化解析前，用于存放日志内容的原始字段，默认值为content。

取值范围：

不涉及。

regex

否

String

参数解释：

正则表达式。用于匹配日志的正则表达式。

取值范围：

不涉及。

keys

否

Array of strings

参数解释：

已提取字段名称。为提取的日志内容设置对应的字段名。

multi_line_regex

否

String

参数解释：

首行正则表达式。

取值范围：

不涉及。

keep_source

否

Boolean

参数解释：

是否上传原始日志。

取值范围：

true：保留原始日志。

false：不保留原始日志。

keep_source_if_parse_error

否

Boolean

参数解释：

是否上传解析失败日志。

取值范围：

true：上传解析失败日志。

false：不上传解析失败日志。

split_sep

否

String

参数解释：

分隔符。根据日志内容选择正确的分隔符，例如竖线（|）。

取值范围：

不涉及

split_type

否

String

参数解释：

分隔类型，支持char-单字符、special_char-不可见字符、string-字符串。

取值范围：

不涉及。

fields

否

Map<String,String>

参数解释：

待添加的字段名和字段值，格式为Key/Value键值对。支持添加多个。

drop_keys

否

Array of strings

参数解释：

丢弃的字段列表。

source_keys

否

Array of strings

参数解释：

待重命名的原始字段。

dest_keys

否

Array of strings

参数解释：

重命名后的字段。

expand_depth

否

Integer

参数解释：

json展开的深度。默认值为0，表示不限制。1表示当前层级，以此类推。

取值范围：

不涉及。

expand_connector

否

String

参数解释：

json展开时的连接符，默认值为英文符号点（.）。

取值范围：

不涉及。

source_format

否

String

参数解释：

原始时间的格式。

取值范围：

不涉及。

source_value

否

String

参数解释：

原始时间字段value。

取值范围：

不涉及。

set_time

否

Boolean

参数解释：

是否将解析后的时间设置为日志时间。

取值范围：

不涉及。

include

否

Map<String,String>

参数解释：

日志过滤白名单规则，格式为Key/Value键值对。Key为日志字段，key不可以重复，长度最大为256个字符。Value为匹配的正则表达式。

exclude

否

Map<String,String>

参数解释：

日志过滤黑名单规则，格式为Key/Value键值对。Key为日志字段，key不可以重复，长度最大为256个字符。Value为匹配的正则表达式。

响应参数

状态码：200

表15 响应Body参数

参数

参数类型

描述

access_config_id

String

参数解释：

日志接入配置ID。

取值范围：

不涉及。

access_config_name

String

参数解释：

日志接入配置名称。

取值范围：

不涉及。

access_config_type

String

参数解释：

日志接入配置类型。

取值范围：

  • AGENT：云主机ECS文本日志接入。

  • K8S_CCE：云容器引擎CCE应用日志接入。

create_time

Long

参数解释：

日志接入配置的创建时间。

取值范围：

不涉及。

access_config_detail

AccessConfigDeatilCreate object

参数解释：

日志接入配置的详细信息。

log_info

AccessConfigQueryLogInfo object

参数解释：

日志接入配置的日志流详情。

host_group_info

AccessConfigHostGroupIdList object

参数解释：

日志接入配置的主机组ID列表。

access_config_tag

Array of accessConfigTag objects

参数解释：

日志接入配置的标签信息。

log_split

Boolean

参数解释：

是否拆分日志。

取值范围：

  • true：进行日志拆分。

  • false：不进行日志拆分。

binary_collect

Boolean

参数解释：

是否采集二进制数据。

取值范围：

  • true：采集二进制数据。

  • false：不采集二级制数据。

cluster_id

String

参数解释：

CCE集群ID。

取值范围：

不涉及。

encoding_format

String

参数解释：

编码格式，默认UTF-8。

取值范围：

不涉及。

incremental_collect

Boolean

参数解释：

是否进行增量采集。

取值范围：

true：采集新增日志数据。

false：采集全量日志数据。

processor_type

String

参数解释：

ICAgent结构化解析类型。

取值范围：

  • SINGLE_LINE

  • MULTI_LINE

  • REGEX

  • MULTI_REGEX

  • SPLIT

  • JSON

  • NGINX

  • COMPOSE

  • ORC

demo_log

String

参数解释：

示例日志。

取值范围：

不涉及。

demo_fields

Array of DemoFieldAccess objects

参数解释：

示例日志解析字段。

processors

Array of Processor objects

参数解释：

ICAgent结构化解析器。

log_split_size

Integer

参数解释：

拆分日志大小。

取值范围：

不涉及。

application_id

String

参数解释：

ServiceStage应用ID。

取值范围：

不涉及。

environment_id

String

参数解释：

ServiceStage环境ID。

取值范围：

不涉及。

component_id

Array of strings

参数解释：

ServiceStage组件ID列表。

recursive_depth

Integer

参数解释：

采集路径递归最大深度。

取值范围：

不涉及。

access_config_type_source

String

参数解释：

日志接入自建软件来源。

取值范围：

  • ECS

  • CCE

  • BMS

  • K8S

  • ServiceStageHost

  • ServiceStage
表16 AccessConfigDeatilCreate

参数

参数类型

描述

paths

Array of strings

参数解释：

采集路径。

  • 路径必须以/或者字母:\开头。

  • 不能包含特殊字符<> ' | " 且不能只输入/。

  • 第一级目录不支持通配符*：不能以/** /*开头。

  • **只能出现一次``

  • CCE类型中容器路径和主机路径必填，标准输出不用。

black_paths

Array of strings

参数解释：

采集黑名单路径。

  • 路径必须以/或者字母:\开头

  • 不能包含特殊字符<> ' | " 且不能只输入/

  • 第一级目录不支持通配符*：不能以/** /*开头

  • **只能出现一次

format

AccessConfigFormatCreate object

参数解释：

日志格式相关信息。

windows_log_info

AccessConfigWindowsLogInfoCreate object

参数解释：

日志接入配置Windows事件日志相关信息。

stdout

Boolean

参数解释：

云容器引擎CCE应用日志接入时，是否开启采集容器标准输出。

取值范围：

  • true：开启采集容器标准输出。

  • false：不开启采集容器标准输出。

stderr

Boolean

参数解释：

云容器引擎CCE应用日志接入时，是否开启采集容器标准错误。

取值范围：

  • true：开启采集容器标准错误。

  • false：不开启采集容器标准错误。

pathType

String

参数解释：

数据源类型。仅云容器引擎CCE应用日志接入支持。

取值范围：

  • HOST_FILE：节点文件类型

  • CONTAINER_STDOUT：容器标准输出

  • CONTAINER_FILE：容器文件路径

  • K8S_EVENT：K8S事件

namespaceRegex

String

参数解释：

K8s Namespace正则匹配。通过Namespace名称指定采集的容器，支持正则匹配。采集名称符合正则规则的Namespace的日志，为空时采集所有Namespace的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

podNameRegex

String

参数解释：

K8s Pod正则匹配。通过Pod名称指定待采集的容器，支持正则匹配。采集名称符合正则规则的Pod的日志，为空时采集所有Pod的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

containerNameRegex

String

参数解释：

K8s容器名称正则匹配。通过容器名称指定待采集的容器（Kubernetes容器名称是定义在spec.containers中），支持正则匹配。采集名称符合正则规则的容器的日志，为空时采集所有容器的日志。

仅云容器引擎CCE应用日志接入支持。

取值范围：

不涉及。

includeLabels

Map<String,String>

参数解释：

容器Label白名单，云容器引擎CCE应用日志接入时，可通过容器Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都匹配；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeLabels

Map<String,String>

参数解释：

容器Label黑名单，云容器引擎CCE应用日志接入时，可通过容器Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都被排除；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

includeEnvs

Map<String,String>

参数解释：

环境变量白名单，云容器引擎CCE应用日志接入时，可通过环境变量白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则环境变量中包含LabelKey的容器都匹配；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeEnvs

Map<String,String>

参数解释：

环境变量黑名单，云容器引擎CCE应用日志接入时，可通过环境变量黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则环境变量中包含LabelKey的容器都被排除；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

logLabels

Map<String,String>

参数解释：

容器 Label日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增容器Label相关字段。例如：设置LabelKey为app，设置LabelValue为app_alias，当容器中包含app=lts时，将在日志中添加内容{app_alias：lts}。

logEnvs

Map<String,String>

参数解释：

环境变量日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增环境变量相关字段。例如：设置环境变量Key为app，设置环境变量Value为app_alias，当K8S中包含环境变量app=lts时，将在日志中添加的内容为{app_alias：lts}。

includeK8sLabels

Map<String,String>

参数解释：

K8s Label白名单，云容器引擎CCE应用日志接入时，可通过K8s Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都匹配；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。

excludeK8sLabels

Map<String,String>

参数解释：

K8s Label黑名单，云容器引擎CCE应用日志接入时，可通过K8s Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。

  • LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。

  • LabelValue：可以为空，长度不能超过512个字符。

若LabelValue为空，则容器 Label中包含LabelKey的容器都被排除；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。

logK8s

Map<String,String>

参数解释：

K8s Label日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增K8s Label相关字段。例如：设置LabelKey为app，设置LabelValue为app_alias，当容器中包含app=lts时，将在日志中添加内容{app_alias：lts}。

repeat_collect

Boolean

参数解释：

是否允许多次采集。

取值范围：

  • true：表示开启，同一主机下的同一日志文件支持被采集到多个日志流。

  • false：表示关闭，采集路径不能重复配置，即同一主机下的同一日志文件，即使跨日志流，也只能配置一次。

system_fields

Array of strings

参数解释：

系统内置字段。配置日志接入规则时，可以配置系统内置字段，上报日志后，每条日志数据的标签数据中将会有系统字段。若修改该字段，将覆盖原有配置。

  • 采集场景为主机文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、__host_group__

  • 采集场景为K8S集群容器文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、clusterId、podName、appName、containerName、nameSpace、__host_group__、serviceID、podIp、clusterName、workloadType、__image_name__

custom_key_value

Map<String,String>

参数解释：

自定义键值对，格式为Key/Value键值对。配置日志接入规则时，可以配置自定义键值对规则，上报日志后，每条日志数据的标签数据中将会有用户自定义的键值对字段。最多支持创建20个。若修改该字段，将覆盖原有配置。

  • Key：允许的字符有a-zA-Z0-9_-，长度不能超过128个字符。

  • Value：长度不能超过1024个字符。

includeLabelsLogical

String

参数解释：

容器 Label白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeLabelsLogical

String

参数解释：

容器 Label黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR

includeK8sLabelsLogical

String

参数解释：

K8S Label白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeK8sLabelsLogical

String

参数解释：

K8S Label黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR

includeEnvsLogical

String

参数解释：

环境变量白名单生效逻辑，默认为OR。新增多条白名单时，支持选择AND或OR的关系，即全部满足或满足任意白名单就可以被匹配。

取值范围：

  • AND

  • OR

excludeEnvsLogical

String

参数解释：

环境变量黑名单生效逻辑，默认为OR。新增多条黑名单时，支持选择AND或OR的关系，即全部满足或满足任意黑名单就可以被匹配。

取值范围：

  • AND

  • OR
表17 AccessConfigFormatCreate

参数

参数类型

描述

single

AccessConfigFormatSingleCreate object

日志接入格式单行日志

multi

AccessConfigFormatMutilCreate object

日志接入格式多行日志
表18 AccessConfigFormatSingleCreate

参数

参数类型

描述

mode

String

单行日志。system：系统时间，wildcard：时间通配符。

value

String

日志时间。当mode为”system”，则填入当前时间戳。当mode为"wildcard"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss
表19 AccessConfigFormatMutilCreate

参数

参数类型

描述

mode

String

单行日志。time：日志时间，regular：正则模式。

value

String

日志时间。当mode为"regular"，则输入正则表达式当mode为"time"，则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss
表20 AccessConfigWindowsLogInfoCreate

参数

参数类型

描述

categorys

Array of strings

采集Windows事件日志类型。

  • Application：应用事件日志

  • System：系统事件日志

  • Security：安全事件日志

  • Setup：启动事件日志

time_offset

AccessConfigTimeOffset object

首次采集时间偏移量

event_level

Array of strings

事件等级。

  • information：表示一般的信息事件，通常不会对系统运行产生影响。

  • warning：表示可能影响系统正常运行的警告事件，但不会导致系统崩溃。

  • error：表示导致系统崩溃或服务无法正常运行的错误事件。

  • critical：表示系统遇到了严重的关键事件，可能导致系统或应用程序的失败。

  • verbose：表示用于记录非常详细的事件信息，这些事件信息通常不会对系统的正常运行产生直接影响。
表21 AccessConfigTimeOffset

参数

参数类型

描述

offset

Long

偏移时间。

当"unit"选择"day"时，范围为1~7天。

当"unit"选择"hour"时，范围为1~168小时。

当"unit"选择"sec"时，范围为1~604800秒。

unit

String

偏移时间单位。

  • day ：天

  • hour：小时

  • sec：秒
表22 AccessConfigQueryLogInfo

参数

参数类型

描述

log_group_id

String

日志组ID

log_stream_id

String

日志流ID

log_group_name

String

日志组名称

log_stream_name

String

日志流名称

log_group_name_alias

String

日志组别名

log_stream_name_alias

String

日志流别名
表23 AccessConfigHostGroupIdList

参数

参数类型

描述

host_group_id_list

Array of strings

主机组ID列表
表24 accessConfigTag

参数

参数类型

描述

key

String

标签Key，不可重复

  • 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。

  • 标签键长度不能超过128个字符。

value

String

标签Value

  • 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。

  • 标签值长度不能超过255个字符。
表25 DemoFieldAccess

参数

参数类型

描述

field_name

String

参数解释：

示例日志解析字段。

取值范围：

不涉及。

field_value

String

参数解释：

示例日志的字段的值。

取值范围：

不涉及。
表26 Processor

参数

参数类型

描述

type

String

参数解释：

结构化解析类型，有以下七种：

  • processor_regex：正则解析。

  • processor_split_string：分词符。

  • processor_json：json解析类型。

  • processor_gotime：自定义时间类型。

  • processor_filter_regex：日志过滤。

  • processor_drop：删除字段类型。

  • processor_rename：修改字段类型。

取值范围：

不涉及。

detail

Detail object

参数解释：

结构化解析配置的相关信息。
表27 Detail

参数

参数类型

描述

source_key

String

参数解释：

原始字段。日志结构化解析前，用于存放日志内容的原始字段，默认值为content。

取值范围：

不涉及。

regex

String

参数解释：

正则表达式。用于匹配日志的正则表达式。

取值范围：

不涉及。

keys

Array of strings

参数解释：

已提取字段名称。为提取的日志内容设置对应的字段名。

multi_line_regex

String

参数解释：

首行正则表达式。

取值范围：

不涉及。

keep_source

Boolean

参数解释：

是否上传原始日志。

取值范围：

true：保留原始日志。

false：不保留原始日志。

keep_source_if_parse_error

Boolean

参数解释：

是否上传解析失败日志。

取值范围：

true：上传解析失败日志。

false：不上传解析失败日志。

split_sep

String

参数解释：

分隔符。根据日志内容选择正确的分隔符，例如竖线（|）。

取值范围：

不涉及

split_type

String

参数解释：

分隔类型，支持char-单字符、special_char-不可见字符、string-字符串。

取值范围：

不涉及。

fields

Map<String,String>

参数解释：

待添加的字段名和字段值，格式为Key/Value键值对。支持添加多个。

drop_keys

Array of strings

参数解释：

丢弃的字段列表。

source_keys

Array of strings

参数解释：

待重命名的原始字段。

dest_keys

Array of strings

参数解释：

重命名后的字段。

expand_depth

Integer

参数解释：

json展开的深度。默认值为0，表示不限制。1表示当前层级，以此类推。

取值范围：

不涉及。

expand_connector

String

参数解释：

json展开时的连接符，默认值为英文符号点（.）。

取值范围：

不涉及。

source_format

String

参数解释：

原始时间的格式。

取值范围：

不涉及。

source_value

String

参数解释：

原始时间字段value。

取值范围：

不涉及。

set_time

Boolean

参数解释：

是否将解析后的时间设置为日志时间。

取值范围：

不涉及。

include

Map<String,String>

参数解释：

日志过滤白名单规则，格式为Key/Value键值对。Key为日志字段，key不可以重复，长度最大为256个字符。Value为匹配的正则表达式。

exclude

Map<String,String>

参数解释：

日志过滤黑名单规则，格式为Key/Value键值对。Key为日志字段，key不可以重复，长度最大为256个字符。Value为匹配的正则表达式。

状态码：400

表28 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表29 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

修改日志接入（ECS）

PUT https://{endpoint}/v3/{project_id}/lts/access-config

{
  "access_config_id" : "ed90802a-8475-4702-955e-e3ee16a5dde9",
  "access_config_detail" : {
    "paths" : [ "/test/222", "/test/111" ],
    "black_paths" : [ ],
    "format" : {
      "multi" : {
        "mode" : "regular",
        "value" : "aaaa"
      }
    },
    "windows_log_info" : {
      "categorys" : [ "Application", "System" ],
      "time_offset" : {
        "offset" : 7,
        "unit" : "day"
      },
      "event_level" : [ "information", "warning", "error", "critical", "verbose" ]
    }
  },
  "host_group_info" : {
    "host_group_id_list" : [ "de4dbed4-a3bc-4877-a7ee-096a2a63e036" ]
  },
  "access_config_tag" : [ {
    "key" : "xxx",
    "value" : "xxx"
  }, {
    "key" : "xxx1",
    "value" : "xxx1"
  } ]
}

响应示例

状态码：200

修改日志接入请求响应成功

{
  "access_config_detail": {
    "black_paths": [
      "/wjy/hei/tesxxx",
      "/wjy/hei/tesxxx"
    ],
    "format": {
      "single": {
        "mode": "wildcard",
        "value": "1111"
      }
    },
    "paths": [
      "/wjy/tesxxx"
    ],
    "windows_log_info": {
      "categorys": [
        "System",
        "Application",
        "Security",
        "Setup"
      ],
      "event_level": [
        "information",
        "warning",
        "error",
        "critical",
        "verbose"
      ],
      "time_offset": {
        "offset": 168,
        "unit": "hour"
      }
    }
  },
  "access_config_id": "aa58d29e-21a9-4761-ba16-8cxxxxd",
  "access_config_name": "采集Wjy_xxxxt2",
  "access_config_tag": [
    {
      "key": "xxx",
      "value": "xxx"
    },
    {
      "key": "xxx1",
      "value": "xxx1"
    }
  ],
  "access_config_type": "AGENT",
  "create_time": 163504332654,
  "host_group_info": {
    "host_group_id_list": [
      "de4dbed4-a3bc-4877-a7ee-09xxxxxx"
    ]
  },
  "log_info": {
    "log_group_id": "9a7e2183-2d6d-4732-9axxxxx49e0",
    "log_group_name": "lts-groupxxxa",
     “log_group_name_alias”: "lts-groupxxxa",
    "log_stream_id": "c4de0538-53e6-41fd-b951-xxxx8d7",
    "log_stream_name": "lts-topixxx",
     “log_stream_name_alias”: "lts-topixxx"
  }
}

状态码：400

非法请求 建议根据error_msg直接修改该请求。

{
  "error_code" : "LTS.1807",
  "error_msg" : "Invalid access config id"
}

状态码：500

表明服务端能被请求访问到，但是服务内部出错。

{
  "error_code" : "LTS.0010",
  "error_msg" : "The system encountered an internal error"
}

状态码

状态码

描述

200

修改日志接入请求响应成功

400

非法请求 建议根据error_msg直接修改该请求。

500

表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 日志接入