# 修改日志接入 - UpdateAccessConfig #### 功能介绍 修改日志接入。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-lts/lts_api_0003.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-lts/lts_api_0046.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | lts:accessConfig:update | Write | accessConfig \* | g:ResourceTag/\ | lts:topics:put | - | | lts:accessConfig:update | Write | hostGroup | - | lts:topics:put | - | #### URI PUT /v3/{project_id}/lts/access-config 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方式请参见：[获取项目ID](https://support.huaweicloud.com/api-lts/lts_api_0006.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 从IAM服务获取的用户Token，获取方式请参见：[获取用户Token](https://support.huaweicloud.com/api-lts/lts_api_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 用于定义消息体的格式。 **约束限制：** 不涉及。 **取值范围：** - application/json;charset=utf8 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | access_config_id | 是 | String | **参数解释：** 日志接入ID。 **约束限制：** 长度固定为36个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | access_config_name | 否 | String | **参数解释：** 日志接入名称。 **约束限制：** 只支持输入英文、数字、中文、中划线、下划线及小数点，且不能以小数点、下划线开头或以小数点结尾，长度不超过64。 **取值范围：** 1-64。 **默认取值：** 不涉及。 | | access_config_detail | 否 | [AccessConfigDeatilUpdate] object | **参数解释：** 日志接入详细信息。 **约束限制：** 不涉及。 | | host_group_info | 否 | [AccessConfigHostGroupIdList] object | **参数解释：** 日志接入主机组ID列表。 **约束限制：** 不涉及。 | | access_config_tag | 否 | Array of [accessConfigTag] objects | **参数解释：** 标签信息。 **约束限制：** KEY不能重复，最多20个标签。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | log_split | 否 | Boolean | **参数解释：** 日志拆分。 **约束限制：** 不涉及。 **取值范围：** - true：进行日志拆分。 - false：不进行日志拆分。 **默认取值：** 不涉及。 | | binary_collect | 否 | Boolean | **参数解释：** 是否采集二进制数据。 **约束限制：** 不涉及。 **取值范围：** - true：采集二进制数据。 - false：不采集二进制数据。 **默认取值：** 不涉及。 | | cluster_id | 否 | String | **参数解释：** CCE集群ID，CCE类型时，为必填。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | incremental_collect | 否 | Boolean | **参数解释：** 是否增量采集。 **约束限制：** 不涉及。 **取值范围：** - true：增量采集。 - false：全量采集。 **默认取值：** 不涉及。 | | encoding_format | 否 | String | **参数解释：** 编码格式。 **约束限制：** 不涉及。 **取值范围：** - UTF-8 - GBK - GB2312 **默认取值：** 不涉及。 | | processor_type | 否 | String | **参数解释：** 结构化解析类型。 **约束限制：** 不涉及。 **取值范围：** - SINGLE_LINE：单行全文。 - MULTI_LINE：多行全文。 - REGEX：单行正则。 - MULTI_REGEX：多行正则。 - SPLIT：分隔符。 - JSON：json解析。 - NGINX：NGINX解析。 **默认取值：** 不涉及。 | | 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。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | disable_labels_prefix | 否 | Boolean | **参数解释：** 是否对结构化上报方式中labels字段中非内置字段添加__labels__.前缀的行为进行禁用。 **约束限制：** 不涉及。 **取值范围：** - true：禁用，不添加__labels__.前缀。 - false：不禁用，即添加__labels__.前缀。 **默认取值：** 不涉及。 | 表4AccessConfigDeatilUpdate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | paths | 否 | Array of strings | **参数解释：** 采集路径。 **约束限制：** - 路径必须以/或者字母:\\开头 - 不能包含特殊字符\<\> ' \| " 且不能只输入/ - 第一级目录不支持通配符\*：不能以/\*\* /\*开头 - \*\*只能出现一次 - 最大数量为10 - 若日志接入已配置绕接规则，请勿修改采集路径，否则将造成绕接规则失效。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | black_paths | 否 | Array of strings | **参数解释：** 采集黑名单路径。 **约束限制：** - 路径必须以/或者字母:\\开头 - 不能包含特殊字符\<\> ' \| " 且不能只输入/ - 第一级目录不支持通配符\*：不能以/\*\* /\*开头 - \*\*只能出现一次 - 最大数量为10 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | format | 否 | [AccessConfigFormatUpdate] object | **参数解释：** 日志格式。 **约束限制：** 若修改format，则single与multi必须选择一种。 | | windows_log_info | 否 | [AccessConfigWindowsLogInfoUpdate] object | **参数解释：** 日志接入采集Windows事件日志。 **约束限制：** 当需要取消Windows日志时，只需传入一个空的windows_log_info字段。 | | stdout | 否 | Boolean | **参数解释：** 标准输出开关，用于控制是否采集标准输出日志。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - true：采集标准输出日志。 - false：不采集标准输出日志。 **默认取值：** 不涉及。 | | stderr | 否 | Boolean | **参数解释：** 标准错误开关，用于控制是否采集标准错误日志。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - true：采集标准错误日志。 - false：不采集标准错误日志。 **默认取值：** 不涉及。 | | combine_stdout | 否 | Boolean | **参数解释：** 云容器引擎CCE应用日志接入时，是否将标准输出和标准错误采集到同一个文件。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - true：将标准输出和标准错误采集到同一个文件（stdout.log）。 - false：将标准输出和标准错误采集到不同的文件（stdout.log和stderr.log）。 **默认取值：** 不涉及。 | | pathType | 否 | String | **参数解释：** CCE接入类型。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - HOST_FILE：主机文件路径。 - CONTAINER_STDOUT：容器标准输出。 - CONTAINER_FILE：容器文件路径。 **默认取值：** 不涉及。 | | namespaceRegex | 否 | String | **参数解释：** K8s Namespace正则匹配。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | podNameRegex | 否 | String | **参数解释：** K8s Pod名称正则匹配。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | containerNameRegex | 否 | String | **参数解释：** K8s 容器名称正则匹配。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | includeLabels | 否 | Map\ | **参数解释：** 容器Label白名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | excludeLabels | 否 | Map\ | **参数解释：** 容器Label黑名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | includeEnvs | 否 | Map\ | **参数解释：** 环境变量白名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | excludeEnvs | 否 | Map\ | **参数解释：** 环境变量黑名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | logLabels | 否 | Map\ | **参数解释：** 容器Label日志标签。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | logEnvs | 否 | Map\ | **参数解释：** 环境变量日志标签。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | includeK8sLabels | 否 | Map\ | **参数解释：** K8s Label白名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | excludeK8sLabels | 否 | Map\ | **参数解释：** K8s Label黑名单。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | logK8s | 否 | Map\ | **参数解释：** K8s Label日志标签。 **约束限制：** 最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | system_fields | 否 | Array of strings | **参数解释：** 系统内置字段。配置日志接入规则时，可以配置系统内置字段，上报日志后，每条日志数据的标签数据中将会有系统字段。 **约束限制：** - 采集场景为主机文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、category、collectTime、__host_group__ - 采集场景为K8S集群容器文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、clusterId、podName、appName、containerName、nameSpace、category、collectTime、__host_group__、serviceID、podIp、clusterName、workloadType、__image_name__ - 若修改时传入此字段，将覆盖原有配置。 - 首次配置元数据时，此字段必填，值为\["pathFile"\]（其中pathFile为默认的必传字段，其余字段可选）。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | custom_key_value | 否 | Map\ | **参数解释：** 自定义键值对。配置日志接入规则时，可以配置自定义键值对规则，上报日志后，每条日志数据的标签数据中将会有用户自定义的键值对字段。 **约束限制：** - 键值对数量不超过20。 - 键的长度限制为128，允许的字符有a-zA-Z0-9_-。 - 值的长度限制为1024。 - 若修改时传入此字段，将覆盖原有配置。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | includeLabelsLogical | 否 | String | **参数解释：** 容器Label白名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | | excludeLabelsLogical | 否 | String | **参数解释：** 容器Label黑名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | | includeK8sLabelsLogical | 否 | String | **参数解释：** K8s Label白名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | | excludeK8sLabelsLogical | 否 | String | **参数解释：** K8s Label黑名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | | includeEnvsLogical | 否 | String | **参数解释：** 环境变量白名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | | excludeEnvsLogical | 否 | String | **参数解释：** 环境变量黑名单生效逻辑。 **约束限制：** 仅CCE接入类型时使用。 **取值范围：** - AND：全部满足才会生效。 - OR：有一项满足就会生效。 **默认取值：** 不涉及。 | 表5AccessConfigFormatUpdate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | single | 否 | [AccessConfigFormatSingle] object | **参数解释：** 单行日志，每一行日志在LTS界面中都显示为一条单独的日志数据。 **约束限制：** 不涉及。 | | multi | 否 | [AccessConfigFormatMutil] object | **参数解释：** 多行日志，日志在LTS界面中多行日志显示为一条日志。 **约束限制：** 不涉及。 | 表6AccessConfigFormatSingle | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mode | 是 | String | **参数解释：** 单行日志采集模式。 **约束限制：** 不涉及 **取值范围：** - system：系统时间。 - wildcard：时间通配符。 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 日志时间。 **约束限制：** 不涉及 **取值范围：** - system：系统时间：则填入当前时间戳。 - 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。 **默认取值：** 不涉及 | 表7AccessConfigFormatMutil | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | mode | 是 | String | **参数解释：** 单行日志。 **约束限制：** 不涉及 **取值范围：** - time：日志时间。 - regular：正则模式。 **默认取值：** 不涉及 | | value | 是 | String | **参数解释：** 日志时间。 **约束限制：** 不涉及 **取值范围：** - time：则时间通配符：用日志打印时间来标识一条日志数据，通过时间通配符来匹配日志，每条日志的行首显示日志的打印时间；如果日志中的时间格式为：2019-01-01 - regular：正则模式。 23:59:59，时间通配符应该填写为：YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为：19-1-1 23:59:59，时间通配符应该填写为：YY-M-D hh:mm:ss。 **默认取值：** 不涉及 | 表8AccessConfigWindowsLogInfoUpdate | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | categorys | 否 | Array of strings | **参数解释：** 采集Windows事件日志类型。 **约束限制：** 不涉及。 **取值范围：** - Application：应用系统。 - System：系统。 - Security：安全。 - Setup：启动。 **默认取值：** 不涉及。 | | time_offset | 否 | [AccessConfigTimeOffset] object | **参数解释：** 日志接入偏移时间。 **约束限制：** 不涉及。 | | event_level | 否 | Array of strings | **参数解释：** 事件等级，根据Windows事件等级过滤采集。 **约束限制：** 仅支持Windows Vista及以上的操作系统。 **取值范围：** - information：提示。 - warning：告警。 - error：错误。 - critical：关键。 - verbose：冗长。 **默认取值：** 不涉及。 | 表9AccessConfigTimeOffset | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 是 | Long | **参数解释：** 具体的偏移时间。 **约束限制：** 不涉及。 **取值范围：** - 当"unit"选择"day"时，offset取值范围为1\~7天。 - 当"unit"选择"hour"时，offset取值范围为1\~168小时。 - 当"unit"选择"sec"时，offset取值范围为1\~604800秒。 **默认取值：** 不涉及。 | | unit | 是 | String | **参数解释：** 具体的偏移时间单位。 **约束限制：** 不涉及。 **取值范围：** - day：天。 - hour：小时。 - sec：秒。 **默认取值：** 不涉及。 | 表10AccessConfigHostGroupIdList | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | host_group_id_list | 是 | Array of strings | **参数解释：** 主机组ID列表。 | 表11accessConfigTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释：** 标签键。 **约束限制：** - 标签键名称不可重复。 - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 **取值范围：** - 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。 - 标签键长度不能超过128个字符。 **默认取值：** 不涉及。 | | value | 否 | String | **参数解释：** 标签值。 **约束限制：** - 标签是以键值对（key-value）的形式表示，key和value为一一对应关系。 - 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 标签值长度不能超过255个字符。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表12DemoFieldAccess | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | field_name | 否 | String | **参数解释：** 示例日志解析字段。 **取值范围：** 不涉及。 | | field_value | 否 | String | **参数解释：** 示例日志的字段的值。 **取值范围：** 不涉及。 | 表13Processor | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 否 | String | **参数解释：** 结构化解析类型。 **约束限制：** 不涉及。 **取值范围：** - processor_regex：正则解析。 - processor_split_string：分词符。 - processor_json：json解析类型。 - processor_gotime：自定义时间类型。 - processor_filter_regex：日志过滤。 - processor_drop：删除字段类型。 - processor_rename：修改字段类型。 **默认取值：** 不涉及。 | | detail | 否 | [Detail] object | **参数解释：** 结构化解析配置的相关信息。 **约束限制：** 不涉及。 | 表14Detail | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | 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\ | **参数解释：** 待添加的字段名和字段值，格式为Key/Value键值对。支持添加多个。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | drop_keys | 否 | Array of strings | **参数解释：** 丢弃的字段列表。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | source_keys | 否 | Array of strings | **参数解释：** 待重命名的原始字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | dest_keys | 否 | Array of strings | **参数解释：** 重命名后的字段。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | expand_depth | 否 | Integer | **参数解释：** json展开的深度。1表示当前层级，以此类推。 **约束限制：** 不涉及。 **取值范围：** 1-10。 **默认取值：** 不涉及。 | | expand_connector | 否 | String | **参数解释：** json展开时的连接符。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | source_format | 否 | String | **参数解释：** 原始时间的格式。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | source_value | 否 | String | **参数解释：** 原始时间字段value。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | set_time | 否 | Boolean | **参数解释：** 是否将解析后的时间设置为日志时间。 **约束限制：** 不涉及。 **取值范围：** - true：将解析后的时间设置为日志时间。 - false：不将解析后的时间设置为日志时间。 **默认取值：** 不涉及。 | | include | 否 | Map\ | **参数解释：** 日志过滤白名单规则，格式为Key/Value键值对。 **约束限制：** Key为日志字段，key不可以重复，长度最大为256个字符。Value为匹配的正则表达式。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | exclude | 否 | Map\ | **参数解释：** 日志过滤黑名单规则，格式为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 [accessConfigTagResp] objects | **参数解释：** 日志接入配置的标签信息。 | | log_split | Boolean | **参数解释：** 是否拆分日志。 **取值范围：** - true：进行日志拆分。 - false：不进行日志拆分。 | | binary_collect | Boolean | **参数解释：** 是否采集二进制数据。 **取值范围：** - true：采集二进制数据。 - false：不采集二进制数据。 | | cluster_id | String | **参数解释：** CCE集群ID。 **取值范围：** 不涉及。 | | encoding_format | String | **参数解释：** 编码格式。 **取值范围：** 不涉及。 | | incremental_collect | Boolean | **参数解释：** 是否进行增量采集。 **取值范围：** - true：采集新增日志数据。 - false：采集全量日志数据。 | | processor_type | String | **参数解释：** ICAgent结构化解析类型。 **取值范围：** - SINGLE_LINE：单行全文 - MULTI_LINE：多行全文 - REGEX：单行正则 - MULTI_REGEX：多行正则 - SPLIT：分隔符 - JSON：json解析 - NGINX：NGINX解析 - COMPOSE： - ORC：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 | 表16AccessConfigDeatilCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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：不开启采集容器标准错误。 | | combine_stdout | Boolean | **参数解释：** 云容器引擎CCE应用日志接入时，是否将标准输出和标准错误采集到同一个文件。 **取值范围：** - true：将标准输出和标准错误采集到同一个文件（stdout.log）。 - false：将标准输出和标准错误采集到不同的文件（stdout.log和stderr.log）。 | | 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\ | **参数解释：** 容器Label白名单，云容器引擎CCE应用日志接入时，可通过容器Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则容器 Label中包含LabelKey的容器都匹配；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。 | | excludeLabels | Map\ | **参数解释：** 容器Label黑名单，云容器引擎CCE应用日志接入时，可通过容器Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则容器 Label中包含LabelKey的容器都被排除；若LabelValue不为空，则容器 Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。 | | includeEnvs | Map\ | **参数解释：** 环境变量白名单，云容器引擎CCE应用日志接入时，可通过环境变量白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则环境变量中包含LabelKey的容器都匹配；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。 | | excludeEnvs | Map\ | **参数解释：** 环境变量黑名单，云容器引擎CCE应用日志接入时，可通过环境变量黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则环境变量中包含LabelKey的容器都被排除；若LabelValue不为空，则环境变量中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。 | | logLabels | Map\ | **参数解释：** 容器 Label日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增容器Label相关字段。例如：设置LabelKey为app，设置LabelValue为app_alias，当容器中包含app=lts时，将在日志中添加内容{app_alias：lts}。 | | logEnvs | Map\ | **参数解释：** 环境变量日志标签，云容器引擎CCE应用日志接入时，可通过该参数在日志中新增环境变量相关字段。例如：设置环境变量Key为app，设置环境变量Value为app_alias，当K8S中包含环境变量app=lts时，将在日志中添加的内容为{app_alias：lts}。 | | includeK8sLabels | Map\ | **参数解释：** K8s Label白名单，云容器引擎CCE应用日志接入时，可通过K8s Label白名单指定待采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则K8s Label中包含LabelKey的容器都匹配；若LabelValue不为空，则K8s Label中包含LabelKey=LabelValue的容器才匹配；LabelKey需要全匹配，LabelValue支持正则匹配。 | | excludeK8sLabels | Map\ | **参数解释：** K8s Label黑名单，云容器引擎CCE应用日志接入时，可通过K8s Label黑名单排除不采集的容器，格式为LabelKey/LabelValue键值对。最多支持创建30个。 - LabelKey：必填项，不能以小数点开头，长度不能超过128个字符。 - LabelValue：可以为空，长度不能超过512个字符。 若LabelValue为空，则K8s Label中包含LabelKey的容器都被排除；若LabelValue不为空，则K8s Label中包含LabelKey=LabelValue的容器才会被排除；LabelKey需要全匹配，LabelValue支持正则匹配。 | | logK8s | Map\ | **参数解释：** 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、category、collectTime、__host_group__ - 采集场景为K8S集群容器文件的内置字段为：hostName、hostId、hostIP、pathFile、hostIPv6、clusterId、podName、appName、containerName、nameSpace、category、collectTime、__host_group__、serviceID、podIp、clusterName、workloadType、__image_name__ | | custom_key_value | Map\ | **参数解释：** 自定义键值对，格式为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 | 表17AccessConfigFormatCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | single | [AccessConfigFormatSingleCreate] object | **参数解释：** 单行日志，每一行日志在LTS界面中都显示为一条单独的日志数据。 | | multi | [AccessConfigFormatMutilCreate] object | **参数解释：** 多行日志，日志在LTS界面中多行日志显示为一条日志。 | 表18AccessConfigFormatSingleCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mode | String | **参数解释：** 单行日志采集模式。 **取值范围：** - system：系统时间。 - wildcard：时间通配符。 | | value | String | **参数解释：** 日志时间。 - 当mode为"system"时 ，value填入当前时间戳。 - 当mode为"wildcard"时，value填入时间通配符。通过时间通配符匹配日志，每条日志的行首显示日志的打印时间，如果日志中的时间格式为2019-01-01 23:59:59，则时间通配符应该填写为YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为19-1-1 23:59:59，则时间通配符应该填写为YY-M-D hh:mm:ss。 **取值范围：** 不涉及。 | 表19AccessConfigFormatMutilCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | mode | String | **参数解释：** 多行日志采集模式。 **取值范围：** - time：日志时间。 - regular：正则模式。 | | value | String | **参数解释：** 日志时间。 - 当mode为"system"时 ，value填入当前时间戳。 - 当mode为"wildcard"时，value填入时间通配符。通过时间通配符匹配日志，每条日志的行首显示日志的打印时间，如果日志中的时间格式为2019-01-01 23:59:59，则时间通配符应该填写为YYYY-MM-DD hh:mm:ss；如果日志中的时间格式为19-1-1 23:59:59，则时间通配符应该填写为YY-M-D hh:mm:ss。 **取值范围：** 不涉及。 | 表20AccessConfigWindowsLogInfoCreate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | categorys | Array of strings | **参数解释：** 采集Windows事件日志类型。有以下四种类型： - Application：应用系统。 - System：系统。 - Security：安全。 - Setup：启动。 | | time_offset | [AccessConfigTimeOffset] object | **参数解释：** 首次采集时间偏移量信息，用于修正时间偏差或计算相对时间。例如设置为7天，表示从采集开始时间前7天内的日志（7天前的日志被忽略），该时间仅在首次配置采集生效，确保不会重复采集。 | | event_level | Array of strings | **参数解释：** 事件等级，根据Windows事件等级过滤采集。仅支持Windows Vista及以上的操作系统。有以下五种等级： - information：提示。 - warning：告警。 - error：错误。 - critical：关键。 - verbose：冗长。 | 表21AccessConfigTimeOffset | 参数 | 参数类型 | 描述 | |:---|:---|:---| | offset | Long | **参数解释：** 具体的偏移时间。 **取值范围：** - 当"unit"选择"day"时，offset取值范围为1\~7天。 - 当"unit"选择"hour"时，offset取值范围为1\~168小时。 - 当"unit"选择"sec"时，offset取值范围为1\~604800秒。 | | unit | String | **参数解释：** 具体的偏移时间单位。 **取值范围：** - day：天。 - hour：小时。 - sec：秒。 | 表22AccessConfigQueryLogInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | log_group_id | String | **参数解释：** 日志组ID。 **取值范围：** 不涉及。 | | log_stream_id | String | **参数解释：** 日志流ID。 **取值范围：** 不涉及。 | | log_group_name | String | **参数解释：** 日志组名称。 **取值范围：** 不涉及。 | | log_stream_name | String | **参数解释：** 日志流名称。 **取值范围：** 不涉及。 | 表23AccessConfigHostGroupIdList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | host_group_id_list | Array of strings | **参数解释：** 主机组ID列表。 | 表24accessConfigTagResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** - 标签键可以包含任意语种的字母、数字和空格，以及_.:=+-@字符，但首尾不能包含空格，且不能以_sys_开头。 - 标签键长度不能超过128个字符。 | | value | String | **参数解释：** 标签值。 **取值范围：** - 标签值可以包含任意语种的字母、数字和空格，以及_.:=+-@字符。 - 标签值长度不能超过255个字符。 | 表25DemoFieldAccess | 参数 | 参数类型 | 描述 | |:---|:---|:---| | field_name | String | **参数解释：** 示例日志解析字段。 **取值范围：** 不涉及。 | | field_value | String | **参数解释：** 示例日志的字段的值。 **取值范围：** 不涉及。 | 表26Processor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 结构化解析类型。 **取值范围：** - processor_regex：正则解析。 - processor_split_string：分词符。 - processor_json：json解析类型。 - processor_gotime：自定义时间类型。 - processor_filter_regex：日志过滤。 - processor_drop：删除字段类型。 - processor_rename：修改字段类型。 | | detail | [Detail] object | **参数解释：** 结构化解析配置的相关信息。 | 表27Detail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_key | String | **参数解释：** 原始字段。日志结构化解析前，用于存放日志内容的原始字段。 **取值范围：** 不涉及。 | | 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\ | **参数解释：** 待添加的字段名和字段值，格式为Key/Value键值对。支持添加多个。 **取值范围：** 不涉及。 | | drop_keys | Array of strings | **参数解释：** 丢弃的字段列表。 **取值范围：** 不涉及。 | | source_keys | Array of strings | **参数解释：** 待重命名的原始字段。 **取值范围：** 不涉及。 | | dest_keys | Array of strings | **参数解释：** 重命名后的字段。 **取值范围：** 不涉及。 | | expand_depth | Integer | **参数解释：** json展开的深度。1表示当前层级，以此类推。 **取值范围：** 1-10。 | | expand_connector | String | **参数解释：** json展开时的连接符。 **取值范围：** 不涉及。 | | source_format | String | **参数解释：** 原始时间的格式。 **取值范围：** 不涉及。 | | source_value | String | **参数解释：** 原始时间字段value。 **取值范围：** 不涉及。 | | set_time | Boolean | **参数解释：** 是否将解析后的时间设置为日志时间。 **取值范围：** - true：将解析后的时间设置为日志时间。 - false：不将解析后的时间设置为日志时间。 | | include | Map\ | **参数解释：** 日志过滤白名单规则，格式为Key/Value键值对。 **取值范围：** 不涉及。 | | exclude | Map\ | **参数解释：** 日志过滤黑名单规则，格式为Key/Value键值对。 **取值范围：** 不涉及。 | **状态码：400** 表28响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 调用失败响应信息描述。 **取值范围：** 不涉及。 | **状态码：500** 表29响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码，请参见：[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。 **取值范围：** 不涉及。 | | 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_stream_id" : "c4de0538-53e6-41fd-b951-xxxx8d7", "log_stream_name" : "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" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 修改自建软件来源为ECS的日志接入 ``` 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.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; import java.util.List; import java.util.ArrayList; public class UpdateAccessConfigSolution { 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); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("")) .build(); UpdateAccessConfigRequest request = new UpdateAccessConfigRequest(); UpdateAccessConfigRequestBody body = new UpdateAccessConfigRequestBody(); List listbodyAccessConfigTag = new ArrayList<>(); listbodyAccessConfigTag.add( new AccessConfigTag() .withKey("xxx") .withValue("xxx") ); listbodyAccessConfigTag.add( new AccessConfigTag() .withKey("xxx1") .withValue("xxx1") ); List listHostGroupInfoHostGroupIdList = new ArrayList<>(); listHostGroupInfoHostGroupIdList.add("de4dbed4-a3bc-4877-a7ee-096a2a63e036"); AccessConfigHostGroupIdList hostGroupInfobody = new AccessConfigHostGroupIdList(); hostGroupInfobody.withHostGroupIdList(listHostGroupInfoHostGroupIdList); List listWindowsLogInfoEventLevel = new ArrayList<>(); listWindowsLogInfoEventLevel.add(AccessConfigWindowsLogInfoUpdate.EventLevelEnum.fromValue("information")); listWindowsLogInfoEventLevel.add(AccessConfigWindowsLogInfoUpdate.EventLevelEnum.fromValue("warning")); listWindowsLogInfoEventLevel.add(AccessConfigWindowsLogInfoUpdate.EventLevelEnum.fromValue("error")); listWindowsLogInfoEventLevel.add(AccessConfigWindowsLogInfoUpdate.EventLevelEnum.fromValue("critical")); listWindowsLogInfoEventLevel.add(AccessConfigWindowsLogInfoUpdate.EventLevelEnum.fromValue("verbose")); AccessConfigTimeOffsetCreate timeOffsetWindowsLogInfo = new AccessConfigTimeOffsetCreate(); timeOffsetWindowsLogInfo.withOffset(7L) .withUnit(AccessConfigTimeOffsetCreate.UnitEnum.fromValue("day")); List listWindowsLogInfoCategorys = new ArrayList<>(); listWindowsLogInfoCategorys.add(AccessConfigWindowsLogInfoUpdate.CategorysEnum.fromValue("Application")); listWindowsLogInfoCategorys.add(AccessConfigWindowsLogInfoUpdate.CategorysEnum.fromValue("System")); AccessConfigWindowsLogInfoUpdate windowsLogInfoAccessConfigDetail = new AccessConfigWindowsLogInfoUpdate(); windowsLogInfoAccessConfigDetail.withCategorys(listWindowsLogInfoCategorys) .withTimeOffset(timeOffsetWindowsLogInfo) .withEventLevel(listWindowsLogInfoEventLevel); AccessConfigFormatMutil multiFormat = new AccessConfigFormatMutil(); multiFormat.withMode(AccessConfigFormatMutil.ModeEnum.fromValue("regular")) .withValue("aaaa"); AccessConfigFormatUpdate formatAccessConfigDetail = new AccessConfigFormatUpdate(); formatAccessConfigDetail.withMulti(multiFormat); List listAccessConfigDetailPaths = new ArrayList<>(); listAccessConfigDetailPaths.add("/test/222"); listAccessConfigDetailPaths.add("/test/111"); AccessConfigDeatilUpdate accessConfigDetailbody = new AccessConfigDeatilUpdate(); accessConfigDetailbody.withPaths(listAccessConfigDetailPaths) .withFormat(formatAccessConfigDetail) .withWindowsLogInfo(windowsLogInfoAccessConfigDetail); body.withAccessConfigTag(listbodyAccessConfigTag); body.withHostGroupInfo(hostGroupInfobody); body.withAccessConfigDetail(accessConfigDetailbody); body.withAccessConfigId("ed90802a-8475-4702-955e-e3ee16a5dde9"); request.withBody(body); try { UpdateAccessConfigResponse response = client.updateAccessConfig(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] 修改自建软件来源为ECS的日志接入 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.v2 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 = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("")) \ .build() try: request = UpdateAccessConfigRequest() listAccessConfigTagbody = [ AccessConfigTag( key="xxx", value="xxx" ), AccessConfigTag( key="xxx1", value="xxx1" ) ] listHostGroupIdListHostGroupInfo = [ "de4dbed4-a3bc-4877-a7ee-096a2a63e036" ] hostGroupInfobody = AccessConfigHostGroupIdList( host_group_id_list=listHostGroupIdListHostGroupInfo ) listEventLevelWindowsLogInfo = [ "information", "warning", "error", "critical", "verbose" ] timeOffsetWindowsLogInfo = AccessConfigTimeOffsetCreate( offset=7, unit="day" ) listCategorysWindowsLogInfo = [ "Application", "System" ] windowsLogInfoAccessConfigDetail = AccessConfigWindowsLogInfoUpdate( categorys=listCategorysWindowsLogInfo, time_offset=timeOffsetWindowsLogInfo, event_level=listEventLevelWindowsLogInfo ) multiFormat = AccessConfigFormatMutil( mode="regular", value="aaaa" ) formatAccessConfigDetail = AccessConfigFormatUpdate( multi=multiFormat ) listPathsAccessConfigDetail = [ "/test/222", "/test/111" ] accessConfigDetailbody = AccessConfigDeatilUpdate( paths=listPathsAccessConfigDetail, format=formatAccessConfigDetail, windows_log_info=windowsLogInfoAccessConfigDetail ) request.body = UpdateAccessConfigRequestBody( access_config_tag=listAccessConfigTagbody, host_group_info=hostGroupInfobody, access_config_detail=accessConfigDetailbody, access_config_id="ed90802a-8475-4702-955e-e3ee16a5dde9" ) response = client.update_access_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] 修改自建软件来源为ECS的日志接入 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/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 := lts.LtsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := lts.NewLtsClient(hcClient) request := &model.UpdateAccessConfigRequest{} keyAccessConfigTag:= "xxx" valueAccessConfigTag:= "xxx" keyAccessConfigTag1:= "xxx1" valueAccessConfigTag1:= "xxx1" var listAccessConfigTagbody = []model.AccessConfigTag{ { Key: &keyAccessConfigTag, Value: &valueAccessConfigTag, }, { Key: &keyAccessConfigTag1, Value: &valueAccessConfigTag1, }, } var listHostGroupIdListHostGroupInfo = []string{ "de4dbed4-a3bc-4877-a7ee-096a2a63e036", } hostGroupInfobody := &model.AccessConfigHostGroupIdList{ HostGroupIdList: listHostGroupIdListHostGroupInfo, } var listEventLevelWindowsLogInfo = []model.AccessConfigWindowsLogInfoUpdateEventLevel{ model.GetAccessConfigWindowsLogInfoUpdateEventLevelEnum().INFORMATION, model.GetAccessConfigWindowsLogInfoUpdateEventLevelEnum().WARNING, model.GetAccessConfigWindowsLogInfoUpdateEventLevelEnum().ERROR, model.GetAccessConfigWindowsLogInfoUpdateEventLevelEnum().CRITICAL, model.GetAccessConfigWindowsLogInfoUpdateEventLevelEnum().VERBOSE, } timeOffsetWindowsLogInfo := &model.AccessConfigTimeOffsetCreate{ Offset: int64(7), Unit: model.GetAccessConfigTimeOffsetCreateUnitEnum().DAY, } var listCategorysWindowsLogInfo = []model.AccessConfigWindowsLogInfoUpdateCategorys{ model.GetAccessConfigWindowsLogInfoUpdateCategorysEnum().APPLICATION, model.GetAccessConfigWindowsLogInfoUpdateCategorysEnum().SYSTEM, } windowsLogInfoAccessConfigDetail := &model.AccessConfigWindowsLogInfoUpdate{ Categorys: &listCategorysWindowsLogInfo, TimeOffset: timeOffsetWindowsLogInfo, EventLevel: &listEventLevelWindowsLogInfo, } multiFormat := &model.AccessConfigFormatMutil{ Mode: model.GetAccessConfigFormatMutilModeEnum().REGULAR, Value: "aaaa", } formatAccessConfigDetail := &model.AccessConfigFormatUpdate{ Multi: multiFormat, } var listPathsAccessConfigDetail = []string{ "/test/222", "/test/111", } accessConfigDetailbody := &model.AccessConfigDeatilUpdate{ Paths: &listPathsAccessConfigDetail, Format: formatAccessConfigDetail, WindowsLogInfo: windowsLogInfoAccessConfigDetail, } request.Body = &model.UpdateAccessConfigRequestBody{ AccessConfigTag: &listAccessConfigTagbody, HostGroupInfo: hostGroupInfobody, AccessConfigDetail: accessConfigDetailbody, AccessConfigId: "ed90802a-8475-4702-955e-e3ee16a5dde9", } response, err := client.UpdateAccessConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/LTS/sdk?api=UpdateAccessConfig)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 修改日志接入请求响应成功 | | 400 | 非法请求 建议根据error_msg直接修改该请求。 | | 500 | 表明服务端能被请求访问到，但是服务内部出错。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-lts/ErrorCode.html)。