PullLogs - 拉取日志

调用PullLogs接口获取指定游标(Cursor)位置的日志数据。此接口获取的是原始日志,如要查询或分析日志,请使用GetLogsV2接口。

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /logstores/{logStore}/shards/{shardId}?type=log HTTP/1.1

请求参数

名称类型必填描述示例值
projectstring

Project 名称。

ali-test-project
logStorestring

Logstore 名称。

ali-test-logstore
shardIdinteger

日志库的分片 id。

1
cursorstring

游标,表示从什么位置开始读取数据,相当于起点。

MTQ0NzMyOTQwMTEwMjEzMDkwNA
countinteger

返回的 Loggroup 数目,最小值为 1,最大值为 1000。

1000
end_cursorstring

结束游标,表示读取数据到什么地方结束,相当于终点。

MTU1NzA1NzQwMTEwMjEzMDkwCg
querystring

过滤语句,spl 语法,请参见 SPL 指令

* | where userId='123'
Accept-Encodingstring

期望服务端返回的数据压缩格式,支持 lz4

lz4

返回参数

名称类型描述示例值
headersobject
Content-Lengthstring

内容长度。

0
Datestring

返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

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

5B0A6B60BB6EE39764D458B5
x-log-countstring

当前返回数量。

5
x-log-cursorstring

当前读取数据下一条 Cursor。

MTQ0NzMyOTQwMTEwMjEzMDkwNA
x-log-cursor-timestring

cursor 的时间戳

x-log-end-of-cursorstring

是否已经拉取到末尾

Content-Typestring

内容类型。

application/json
x-log-compresstypestring

压缩格式。

*
x-log-bodyrawsizestring

请求 Body 压缩后大小。

0
LogGroupList

压缩后的 pb 数据

示例

正常返回示例

JSON格式

{
  "logGroupList": [
    {
      "Topic": "topic-test",
      "Source": "192.1.1.1",
      "LogTags": [
        {
          "Key": "key-test",
          "Value": "value-test"
        }
      ],
      "Logs": [
        {
          "Time": 1690254376,
          "Contents": [
            {
              "Key": "key-test",
              "Value": "value-test"
            }
          ]
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-09-06新增 OpenAPI查看变更详情