文档

UpdateConfig

更新时间:

调用UpdateConfig接口更新Logtail配置。

接口说明

  • Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
  • 更新已经被应用到机器组的Logtail配置,则对应机器组的Logtail配置会立即生效。
  • 已创建并获取AccessKey。更多信息,请参见访问密钥

    阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权

  • 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project
  • 已规划好Logtail采集配置。更多信息,请参见Logtail配置

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

PUT /configs/{configName} HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

project String Host ali-test-project

Project名称。

configName String Path test-sample

Logtail配置的名称。

LogtailConfig Body

请求消息体。

返回数据

名称

类型

示例值

描述

Server String nginx

服务器名称。

Content-Type String application/json

返回的响应体的内容格式。

Content-Length String 0

响应内容长度。

Connection String close

是否长连接。取值包括:

  • close:不是长连接,则每个HTTP请求都会重新建立TCP连接。
  • keep-alive:长连接,TCP连接建立后保持连接状态,节省连接所需时间和带宽。
Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识,该请求的唯一ID。

示例

请求示例

PUT /configs/test-sample HTTP/1.1
Host:ali-project-test.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

{
  "configName" : "test-config",
  "logSample" : "2022-06-14 11:13:29.796 | DEBUG    | __main__:<module>:1 - hello world",
  "inputType" : "file",
  "outputType" : "LogService",
  "outputDetail" : {
    "endpoint" : "cn-hangzhou-intranet.log.aliyuncs.com",
    "logstoreName" : "test-logstore",
    "region" : "cn-hangzhou"
  },
  "createTime" : 1655176807,
  "lastModifyTime" : 1655176807
}

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

访问错误中心查看更多错误码。

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ConfigNotExist

Config configName does not exist.

Logtail配置不存在。

400

InvalidParameter

invalid config resource json.

无效Logtail配置参数。

400

BadRequest

Config resource configname does not match with request.

Logtail配置名称不符合要求。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息,请参见通用错误码

  • 本页导读 (1)
文档反馈