PullLogs - 拉取日志_日志服务(SLS)-阿里云帮助中心

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

接口说明

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

获取日志时必须指定 Shard。
目前仅支持读取Protocol Buffer格式数据。
请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。

调试

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

调试

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
project	string	是	Project 名称。	ali-test-project
logStore	string	是	Logstore 名称。	ali-test-logstore
shardId	integer	是	日志库的分片 id。	1
cursor	string	是	游标，表示从什么位置开始读取数据，相当于起点。	MTQ0NzMyOTQwMTEwMjEzMDkwNA
count	integer	是	返回的 Loggroup 数目，最小值为 1，最大值为 1000。	1000
end_cursor	string	否	结束游标，表示读取数据到什么地方结束，相当于终点。	MTU1NzA1NzQwMTEwMjEzMDkwCg
query	string	否	过滤语句，spl 语法，请参见 SPL 指令	* \| where userId='123'
Accept-Encoding	string	否	期望服务端返回的数据压缩格式，支持 lz4	lz4

PullLogs 接口的特有请求头如下所示：

Accept：application/x-protobuf
Accept-Encoding：lz4

其中，Accept-Encoding 取值包括 lz4、deflate 或双引号（""）之一。

请求示例：

GET /logstores/sls-test-logstore/shards/0?type=logs&cursor=MTQ0NzMyOTQwMTEwMjEzMDkwNA&count=1000 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

返回参数

名称	类型	描述	示例值
headers	object
Content-Length	string		0
Date	string		Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string		5B0A6B60BB6EE39764D458B5
x-log-count	string
x-log-cursor	string
x-log-cursor-time	string
x-log-end-of-cursor	string
Content-Type	string		application/json
x-log-compresstype	string
x-log-bodyrawsize	string
	LogGroupList	压缩后的 pb 数据

PullLogs 接口的特有响应元素如下所示：

x-log-cursor：当前读取数据下一条 Cursor。
x-log-end-of-cursor：当前读取数据最后一条 Cursor。
x-log-count：当前返回数量。

关于 Log Service API 的公共响应头，请参见公共响应头。

响应元素为 protobuf 格式序列化后的数据（可能经过压缩）。

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。