更新时间：2025-03-21 GMT+08:00

创建日志接入

功能介绍

创建日志接入

URI

POST /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_name	是	String	日志接入名称。满足正则表达式：^(?!.)(?!)(?!.?.$)[\u4e00-\u9fa5a-zA-Z0-9-*.]{1,64}$ 最小长度：1 最大长度：64
access_config_type	是	String	日志接入类型。AGENT：ECS接入,K8S_CCE:CCE接入
access_config_detail	是	AccessConfigDeatilCreate object	访问配置详细信息
log_info	是	AccessConfigBaseLogInfoCreate object	日志信息
host_group_info	否	AccessConfigHostGroupIdListCreate object	主机组信息
access_config_tag	否	Array of accessConfigTag objects	标签信息。KEY不能重复，最多20个标签
binary_collect	否	Boolean	二进制采集
log_split	否	Boolean	日志拆分
cluster_id	否	String	集群ID

表4 AccessConfigDeatilCreate
参数	是否必选	参数类型	描述
paths	否	Array of strings	采集路径。路径必须以/或者字母:\开头不能包含特殊字符<> ' \| " 且不能只输入/ 第一级目录不支持通配符：不能以/* /开头 4.*只能出现一次`` CCE类型中容器路径和主机路径必填，标准输出不用
black_paths	否	Array of strings	采集路径黑名单。路径必须以/或者字母:\开头不能包含特殊字符<> ' \| " 且不能只输入/ 第一级目录不支持通配符：不能以/* /开头 4.*只能出现一次
format	是	AccessConfigFormatCreate object	日志格式。
windows_log_info	否	AccessConfigWindowsLogInfoCreate object	日志接入采集Windows事件日志
stdout	否	Boolean	标准输出开关，仅CCE接入类型时使用
stderr	否	Boolean	标准输出开关标准错误开关，仅CCE接入类型时使用
pathType	否	String	CCE接入类型，仅CCE接入类型时使用
namespaceRegex	否	String	K8s Namespace正则匹配，仅CCE接入类型时使用
podNameRegex	否	String	K8s Pod正则匹配，仅CCE接入类型时使用
containerNameRegex	否	String	K8s 容器名称正则匹配，仅CCE接入类型时使用
includeLabels	否	Map<String,String>	容器 Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeLabels	否	Map<String,String>	容器 Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeEnvs	否	Map<String,String>	环境变量白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeEnvs	否	Map<String,String>	环境变量黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logLabels	否	Map<String,String>	容器 Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logEnvs	否	Map<String,String>	环境变量日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeK8sLabels	否	Map<String,String>	K8s Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeK8sLabels	否	Map<String,String>	K8s Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logK8s	否	Map<String,String>	K8s Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用

表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** AccessConfigBaseLogInfoCreate
参数	是否必选	参数类型	描述
log_group_id	是	String	日志组ID。项目ID，获取方式请参见：获取账号租户ID、项目资源集ID、日志组ID、日志流ID。最小长度：36 最大长度：36
log_stream_id	是	String	日志流ID。项目ID，获取方式请参见：获取账号租户ID、项目资源集ID、日志组ID、日志流ID。最小长度：36 最大长度：36

**表11** AccessConfigHostGroupIdListCreate
参数	是否必选	参数类型	描述
host_group_id_list	是	Array of strings	主机组ID列表最小长度：36 最大长度：36

**表12** accessConfigTag
参数	是否必选	参数类型	描述
key	是	String	标签Key：只支持输入UTF-8格式表示的字母(包含中文)、数字和空格，以及以下_ . : = + - @字符且不能以下划线开头。长度不能超过128个字符
value	否	String	标签Value：只支持输入UTF-8格式表示的字母(包含中文)、数字和空格，以及以下_ . : / = + - @字符，长度不能超过255个字符。

响应参数

状态码：200

**表13** 响应Body参数
参数	参数类型	描述
access_config_id	String	日志接入ID
access_config_name	String	日志接入名称
access_config_type	String	日志接入类型。AGENT：主机接入
create_time	Long	创建时间
access_config_detail	AccessConfigDeatilResponse object	日志接入详细信息
log_info	AccessConfigQueryLogInfo object	日志接入日志详情
host_group_info	AccessConfigHostGroupIdList object	日志接入主机组ID列表
access_config_tag	Array of accessConfigTagResponse objects	标签信息。
log_split	Boolean	日志拆分
binary_collect	Boolean	二进制收集
cluster_id	String	CCE集群ID

**表14** AccessConfigDeatilResponse
参数	参数类型	描述
paths	Array of strings	采集路径。
black_paths	Array of strings	采集路径黑名单。
format	AccessConfigFormatCreate object	日志格式。
windows_log_info	AccessConfigWindowsLogInfoCreate object	日志接入采集Windows事件日志
stdout	Boolean	标准输出开关，仅CCE接入类型时使用
stderr	Boolean	标准输出开关标准错误开关，仅CCE接入类型时使用
pathType	String	CCE接入类型，仅CCE接入类型时使用
namespaceRegex	String	K8s Namespace正则匹配，仅CCE接入类型时使用
podNameRegex	String	K8s Pod正则匹配，仅CCE接入类型时使用
containerNameRegex	String	K8s 容器名称正则匹配，仅CCE接入类型时使用
includeLabels	Map<String,String>	容器 Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeLabels	Map<String,String>	容器 Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeEnvs	Map<String,String>	环境变量白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeEnvs	Map<String,String>	环境变量黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logLabels	Map<String,String>	容器 Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logEnvs	Map<String,String>	环境变量日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
includeK8sLabels	Map<String,String>	K8s Label白名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
excludeK8sLabels	Map<String,String>	K8s Label黑名单，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用
logK8s	Map<String,String>	K8s Label日志标签，最多支持创建30个，keyname不支持重名，仅CCE接入类型时使用

**表15** AccessConfigFormatCreate
参数	参数类型	描述
single	AccessConfigFormatSingleCreate object	日志接入格式单行日志
multi	AccessConfigFormatMutilCreate object	日志接入格式多行日志

**表16** 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

**表17** 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

**表18** AccessConfigWindowsLogInfoCreate
参数	参数类型	描述
categorys	Array of strings	采集Windows事件日志类型。 Application：应用事件日志 System：系统事件日志 Security：安全事件日志 Setup：启动事件日志
time_offset	AccessConfigTimeOffset object	首次采集时间偏移量
event_level	Array of strings	事件等级。 information：表示一般的信息事件，通常不会对系统运行产生影响。 warning：表示可能影响系统正常运行的警告事件，但不会导致系统崩溃。 error：表示导致系统崩溃或服务无法正常运行的错误事件。 critical：表示系统遇到了严重的关键事件，可能导致系统或应用程序的失败。 verbose：表示用于记录非常详细的事件信息，这些事件信息通常不会对系统的正常运行产生直接影响。

**表19** AccessConfigTimeOffset
参数	参数类型	描述
offset	Long	偏移时间。当"unit"选择"day"时，范围为1~7天。当"unit"选择"hour"时，范围为1~168小时。当"unit"选择"sec"时，范围为1~604800秒。
unit	String	偏移时间单位。 day ：天 hour：小时 sec：秒

**表20** 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	日志流别名

**表21** AccessConfigHostGroupIdList
参数	参数类型	描述
host_group_id_list	Array of strings	主机组ID列表

**表22** accessConfigTagResponse
参数	参数类型	描述
key	String	标签Key
value	String	标签Value

状态码：400

**表23** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

状态码：500

**表24** 响应Body参数
参数	参数类型	描述
error_code	String	错误码
error_msg	String	错误描述

请求示例

创建日志接入（CCE接入）

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

{
  "access_config_name" : "myapinew322",
  "access_config_type" : "K8S_CCE",
  "access_config_detail" : {
    "pathType" : "CONTAINER_STDOUT",
    "stdout" : "true",
    "stderr" : "false",
    "format" : {
      "single" : {
        "mode" : "system",
        "value" : "1678969382000"
      }
    },
    "namespaceRegex" : "default",
    "podNameRegex" : "abc",
    "containerNameRegex" : "my",
    "includeLabels" : {
      "a" : "1"
    },
    "excludeLabels" : {
      "b" : "2"
    },
    "logLabels" : {
      "c" : "3"
    },
    "includeK8sLabels" : {
      "d" : "4"
    },
    "excludeK8sLabels" : {
      "e" : "5"
    },
    "logK8s" : {
      "f" : "6"
    },
    "includeEnvs" : {
      "g" : "7"
    },
    "excludeEnvs" : {
      "h" : "8"
    },
    "logEnvs" : {
      "i" : "9"
    }
  },
  "log_info" : {
    "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b",
    "log_stream_id" : "3581bee9-8698-476e-a0ba-b0f310ed99cf"
  },
  "host_group_info" : {
    "host_group_id_list" : [ "12b0bbd1-4eda-456b-a641-647aa66bdeab" ]
  },
  "access_config_tag" : [ {
    "key" : "my01",
    "value" : "001"
  }, {
    "key" : "my02",
    "value" : "002"
  } ],
  "binary_collect" : "false",
  "log_split" : "false"
}

创建日志接入（ECS接入）

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

{
  "access_config_name" : "Tesxxx",
  "access_config_type" : "AGENT",
  "access_config_detail" : {
    "paths" : [ "/test/xxx", "/texxx" ],
    "black_paths" : [ "/testxxx", "/tesxxx" ],
    "format" : {
      "multi" : {
        "mode" : "time",
        "value" : "YYYY-MM-DD hh:mm:ss"
      }
    },
    "windows_log_info" : {
      "categorys" : [ "System", "Security", "Setup" ],
      "event_level" : [ "warning", "error", "critical", "verbose" ],
      "time_offset" : {
        "offset" : 111,
        "unit" : "hour"
      }
    }
  },
  "log_info" : {
    "log_group_id" : "b179326d-c3be-4217-a3d9-xxxx",
    "log_stream_id" : "020a6fa0-4740-4888-af06-98xxxxxx"
  },
  "host_group_info" : {
    "host_group_id_list" : [ "4ee44d4f-a72b-40cf-a3c7-1xxxxx" ]
  },
  "access_config_tag" : [ {
    "key" : "xxx",
    "value" : "xxx"
  }, {
    "key" : "xxx1",
    "value" : "xxx1"
  } ]
}

响应示例

状态码：200

创建日志接入请求响应成功

{
  "access_config_detail" : {
    "containerNameRegex" : "container-1",
    "format" : {
      "single" : {
        "mode" : "system",
        "value" : "1678969382000"
      }
    },
    "namespaceRegex" : "default",
    "pathType" : "container_stdout",
    "paths" : [ ],
    "podNameRegex" : "mystdout-6d7458d77c-rhjcc",
    "stderr" : true,
    "stdout" : true
  },
  "access_config_id" : "03b16999-95cf-453b-9668-7aa1fafa564e",
  "access_config_name" : "myapinew32Y",
  "access_config_tag" : [ {
    "key" : "my01",
    "value" : "001"
  }, {
    "key" : "my02",
    "value" : "002"
  } ],
  "access_config_type" : "K8S_CCE",
  "binary_collect" : true,
  "create_time" : 1685626665176,
  "log_info" : {
    "log_group_id" : "9575cb24-290c-478e-a5db-88d6d1dc513b",
    "log_group_name" : "my-group",
    "log_stream_id" : "eea03c27-e041-4bec-bd03-6afa10a6561a",
    "log_stream_name" : "lts-topic-cceapi"
  },
  "log_split" : true
}

状态码：400

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

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

状态码：500

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

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

状态码

状态码	描述
200	创建日志接入请求响应成功
400	非法请求建议根据error_msg直接修改该请求。
500	表明服务端能被请求访问到，但是服务内部出错。

错误码

请参见错误码。

父主题： 日志接入

上一篇：查询日志接入

下一篇：删除日志接入

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试