全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
日志服务

UpdateConfig

更新时间:2017-12-28 10:11:53

更新配置内容,如果配置被应用到机器组,对应机器也会同时更新。

示例:

PUT /configs/{configName}

请求语法

  1. PUT /configs/<configName> HTTP/1.1
  2. Authorization: <AuthorizationString>
  3. Content-Type:application/json
  4. Content-Length:<Content Length>
  5. Content-MD5<:<Content MD5>
  6. Date: <GMT Date>
  7. Host: <Project Endpoint>
  8. x-log-apiversion: 0.6.0
  9. x-log-signaturemethod: hmac-sha1
  10. {
  11. "configName": "testcategory1",
  12. "inputType": "file",
  13. "inputDetail": {
  14. "logType": "common_reg_log",
  15. "logPath": "/var/log/httpd/",
  16. "filePattern": "access.log",
  17. "localStorage": true,
  18. "timeFormat": "%Y/%m/%d %H:%M:%S",
  19. "logBeginRegex": ".*",
  20. "regex": "(\w+)(\s+)",
  21. "key" :["key1", "key2"],
  22. "filterKey":["key1"],
  23. "filterRegex":["regex1"],
  24. "topicFormat": "none"
  25. },
  26. "outputType": "LogService",
  27. "outputDetail":
  28. {
  29. "logstoreName": "perfcounter"
  30. }
  31. }

请求参数

属性名称 类型 是否必须 描述
configName string 日志配置名称, project 下唯一
inputType string 输入类型,现在只支持 file
inputDetail json 见下表格说明
outputType string 输出类型,现在只支持 LogService
outputDetail json 见下表格说明

inputDetail 内容:

属性名称 类型 必须 描述
logType string 日志类型,现在只支持 common_reg_log
logPath string 日志所在的父目录,例如 /var/logs/
filePattern string 日志文件的 Pattern,例如 access*.log
localStorage boolean 是否打开本地缓存,在服务端之间链路断开的情况下,本地可以缓存 1GB 日志
timeFormat string 日志时间格式,如 %Y/%m/%d %H:%M:%S
logBeginRegex string 日志首行特征(正则表达式),由于匹配多行日志组成一条 log 的情况
regex string 日志对提取正则表达式
key array 日志提取后所生成的 Key
filterKey array 用于过滤日志所用到的 key,只有 key 的值满足对应 filterRegex 列中设定的正则表达式日志才是符合要求的
filterRegex array 和每个 filterKey 对应的正正则表达式, filterRegex 的长度和 filterKey 的长度必须相同
topicFormat string 用于将日志文件路径的某部分作为 topic,如 /var/log/(.*).log,默认为 none,表示 topic 为空
preserve boolean true 代表监控目录永不超时,false 代表监控目录 30 分钟超时,默认值为 true
preserveDepth integer 当设置 preserve 为 false 时,指定监控不超时目录的深度,最大深度支持 3
fileEncoding string 支持两种类型:utf8、gbk,默认值为utf8 

outputDetail 内容:

属性名称 类型 必须 描述
logstoreName string 对应 logstore 名称

请求头

无特有请求头。关于 API 的公共请求头,请参考 公共请求头

响应头

无特有响应头。关于 API 的公共响应头,请参考 公共响应头

响应元素

返回值:成功返回 200 状态码。

错误码

除了返回 API 的 通用错误码,还可能返回如下特有错误码:

HTTP 状态码 ErrorCode ErrorMessage
404 ConfigNotExist config {Configname} not exist
400 InvalidParameter invalid config resource json
400 BadRequest config resource configname not match request
500 InternalServerError internal server error

细节描述

创建过程中遇到格式错误、必要参数遗失、或者 quota 超过限制等错误,则会创建失败。

示例

请求示例:
  1. PUT /configs/logtail-config-sample
  2. Header :
  3. {
  4. "Content-Length": 737,
  5. "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",
  6. "x-log-bodyrawsize": 737,
  7. "Content-MD5": "431263EB105D584A5555762A81E869C0",
  8. "x-log-signaturemethod": "hmac-sha1",
  9. "Date": "Mon, 09 Nov 2015 09:14:32 GMT",
  10. "x-log-apiversion": "0.6.0",
  11. "User-Agent": "log-python-sdk-v-0.6.0",
  12. "Content-Type": "application/json",
  13. "Authorization": "LOG 94to3z418yupi6ikawqqd370:GTPzFbLe8PZW0OFxTk/xMoCXA9E="
  14. }
  15. Body :
  16. {
  17. "outputDetail": {
  18. "logstoreName": "sls-test-logstore"
  19. },
  20. "inputType": "file",
  21. "inputDetail": {
  22. "regex": "([\\d\\.]+) \\S+ \\S+ \\[(\\S+) \\S+\\] \"(\\w+) ([^\"]*)\" ([\\d\\.]+) (\\d+) (\\d+) (\\d+|-) \"([^\"]*)\" \"([^\"]*)\".*",
  23. "filterKey": [],
  24. "logPath": "/var/log/nginx/",
  25. "logBeginRegex": "\\d+\\.\\d+\\.\\d+\\.\\d+ - .*",
  26. "logType": "common_reg_log",
  27. "topicFormat": "none",
  28. "localStorage": true,
  29. "key": [
  30. "ip",
  31. "time",
  32. "method",
  33. "url",
  34. "request_time",
  35. "request_length",
  36. "status",
  37. "length",
  38. "ref_url",
  39. "browser"
  40. ],
  41. "filePattern": "access*.log",
  42. "timeFormat": "%d/%b/%Y:%H:%M:%S",
  43. "filterRegex": []
  44. },
  45. "outputType": "LogService",
  46. "configName": "logtail-config-sample"
  47. }
响应示例:
  1. {
  2. "date": "Mon, 09 Nov 2015 09:14:32 GMT",
  3. "connection": "close",
  4. "x-log-requestid": "564063F899248CAA2300B778",
  5. "content-length": "0",
  6. "server": "nginx/1.6.1"
  7. }
本文导读目录