PutLogs
向指定的Logstore中写入日志数据
服务地址:
华东1 金融云
输入参数
只看必填
projectProject名称
logstoreLogstore名称
x-log-compresstype日志压缩类型
body日志组
Topic日志主题
Source日志的来源
LogTags日志的标签列表
0日志标签
Key自定义Key名称
Value自定义Key对应的值
LogItems日志列表
0日志
Time日志时间
Contents日志字段列表
0日志字段
Key自定义Key名称
Value自定义Key对应的值
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

警告 目前 OpenAPI SDK 不支持此接口,请使用日志服务 SDK

  • 服务端会对每次 PutLogs 写入的日志数据做格式检查,只要日志数据中有任何一条日志不符合规范,则整个请求失败且无任何日志数据成功写入。
  • 目前仅支持写入 PB 格式的日志数据,日志数据以 LogGroup 的形式展示。
  • 日志数据写入时有两种模式:
    • 负载均衡模式(LoadBalance):自动根据 Logstore 下所有可写的 Shard 进行负载均衡写入。该方法写入可用性较高,适合不保证顺序的数据消费场景。
    • Key 路由 Shard 模式(KeyHash):在 URL 参数中增加 Key 字段,用来判断数据写入哪个 Shard 中。该参数为可选参数,不设置时自动切换为负载均衡写入模式。例如,可以将某个生产者(例如 instance)根据名称 Hash 固定到 Shard 上,这样就能保证写入与消费在该 Shard 上的数据是严格有序的(在合并、分裂过程中能够严格保证对于 Key 在一个时间点只会出现在一个 Shard 上,请参见分区(Shard)
  • PutLogs 接口每次可以写入的原始日志大小上限为 10 MB,日志组中每条日志下的 Value 部分建议不超过 1 MB。历史版本的 SDK 可能存在不同限制,建议升级到最新的版本解决。
  • 在 SDK 参考中,日志服务提供 Java 和 Python SDK 等 PutLogs 的使用示例。更多信息,请参见Java SDK 快速入门Python SDK 快速入门等。

请求语法

POST /logstores/{logstore}/shards/lb HTTP/1.1

路径参数

字段名称字段详情
logstorestring

Logstore 名称。

示例值:ali-test-logstore

请求参数

字段名称字段详情
projectstring

Project 名称。

示例值:ali-test-project
x-log-compresstypestring

日志压缩类型,目前支持 lz4、gzip 两种类型。

示例值:lz4枚举值:lz4
bodyobject

日志组

请求说明

请求头

关于 Log Service API 的公共请求头,请参见公共请求头

请求示例:

POST /logstores/sls-test-logstore/shards/lb
{
    "Content-Length": 118,
    "Content-Type":"application/x-protobuf",
    "x-log-bodyrawsize":1356,
    "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",
    "Content-MD5":"6554BD042149C844761C2C094A8FECCE",
    "Date":"Thu, 12 Nov 2015 06:54:26 GMT",
    "x-log-apiversion": "0.6.0",
    "x-log-compresstype":"lz4"
    "x-log-signaturemethod": "hmac-sha1",
    "Authorization":"LOG yourAccessKeyId:yourSignature"
}
<PB 格式日志使用 Lz4 压缩后的二进制数据>

返回参数

返回说明

响应头

PutLogs 接口无特有响应头。关于 Log Service API 的公共响应头,请参见公共响应头

响应元素

返回 HTTP 状态码 200,则表示请求成功。该接口调用成功后无任何响应元素。

变更历史
变更时间变更内容概要操作
2024-09-06
新增OpenAPI,写入日志