调用CreateConfig接口创建Logtail配置。
接口说明
- 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息,请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询,请参见管理Project。
- 每个Project最多可创建100个Logtail配置。
- 已规划好Logtail采集配置。更多信息,请参见Logtail配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
POST /configs HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
project | String | Host | 是 | ali-test-project |
Project名称。 |
Object | Body | 否 |
请求消息体。 |
||
configName | String | Body | 是 | config-sample |
Logtail配置的名称,在其所属Project内必须唯一。创建Logtail配置成功后,无法修改其名称。命名规则如下:
|
logSample | String | Body | 否 | logsample |
日志样例。 |
inputType | String | Body | 是 | file |
日志输入的方式。可选值如下:
|
inputDetail | Map | Body | 是 | “logType”: “common_reg_log”, “logPath”: “/var/log/httpd/”, “filePattern”: “access*.log”, “localStorage”: true, “timeFormat”: “%Y/%m/%d %H:%M:%S”, “logBeginRegex”: “.*”, “regex”: “(\w+)(\s+)”, “key” :[“key1”, “key2”], “filterKey”:[“key1”], “filterRegex”:[“regex1”], “fileEncoding”:”utf8″, “topicFormat”: “none” |
inputDetail参数说明。 |
Any | Body | 否 | “logType”: “common_reg_log”, “logPath”: “/var/log/httpd/”, “filePattern”: “access*.log”, “localStorage”: true, “timeFormat”: “%Y/%m/%d %H:%M:%S”, “logBeginRegex”: “.*”, “regex”: “(\w+)(\s+)”, “key” :[“key1”, “key2”], “filterKey”:[“key1”], “filterRegex”:[“regex1”], “fileEncoding”:”utf8″, “topicFormat”: “none” |
inputDetail参数。 |
|
outputType | String | Body | 是 | LogService |
日志输出的方式,只支持LogService,即只支持将数据上传到日志服务。 |
outputDetail | Object | Body | 是 |
日志输出的相关配置。更多信息,请参见outputDetail参数说明。 |
|
endpoint | String | Body | 是 | cn-hangzhou.log.aliyuncs.com |
服务入口。更多信息,请参见服务入口。 |
logstoreName | String | Body | 是 | test-logstore |
Logstore名称。 |
region | String | Body | 否 | cn-hangzhou |
地域。 |
createTime | Long | Body | 否 | 1453949705 |
Logtail配置创建时间。UNIX时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。 |
lastModifyTime | Long | Body | 否 | 1524155379 |
Logtail配置最后一次更新时间。UNIX时间戳格式,表示从1970-1-1 00:00:00 UTC计算起的秒数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
Server | String | nginx |
服务器名称。 |
Content-Type | String | application/json |
返回的响应体的内容格式。 |
Content-Length | String | 0 |
内容长度。 |
Connection | String | close |
是否长链接。取值包括:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT |
时间。 |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 |
服务端产生的标识,该请求的唯一ID。 |
示例
请求示例
POST /configs HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
{
"configName" : "config-sample",
"logSample" : "logsample",
"inputType" : "file",
"inputDetail" : {
"key" : "\"logType\": \"common_reg_log\", \"logPath\": \"/var/log/httpd/\", \"filePattern\": \"access*.log\", \"localStorage\": true, \"timeFormat\": \"%Y/%m/%d %H:%M:%S\", \"logBeginRegex\": \".*\", \"regex\": \"(\w+)(\s+)\", \"key\" :[\"key1\", \"key2\"], \"filterKey\":[\"key1\"], \"filterRegex\":[\"regex1\"], \"fileEncoding\":\"utf8\", \"topicFormat\": \"none\""
},
"outputType" : "LogService",
"outputDetail" : {
"endpoint" : "cn-hangzhou.log.aliyuncs.com",
"logstoreName" : "test-logstore",
"region" : "cn-hangzhou"
},
"createTime" : 1453949705,
"lastModifyTime" : 1524155379
}
正常返回示例
JSON
格式
HTTP/1.1 200 OK
错误码
访问错误中心查看更多错误码。
HttpStatusCode |
ErrorCode |
ErrorMessage |
错误码描述 |
404 |
ProjectNotExist |
Project does not exist. |
Project不存在。 |
404 |
ConfigAlreadyExist |
config configname already exists. |
Logtail配置已存在。 |
400 |
InvalidParameter |
Invalid config resource json. |
无效的Logtail配置参数。 |
500 |
InternalServerError |
Specified Server Error Message. |
内部服务调用错误。 |
更多信息,请参见通用错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/160401.html