调用PullLogs接口获取指定游标（Cursor）位置的日志数据。

接口说明

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

调试

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

请求头

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

请求语法

GET /logstores/{logstore}/shards/{shard} HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host 是 ali-test-project

Project名称。
logstore String Path 是 sls-test-logstore

Logstore名称。
shard Long Path 是 0

Shard ID。
type String Query 是 logs

请求类型，固定取值为logs。
cursor String Query 是 MTQ0NzMyOTQwMTEwMjEzMDkwNA

游标，表示从什么位置开始读取数据，相当于起点。
count Long Query 是 1000

返回的Loggroup数目，最小值为1，最大值为1000。
end_cursor String Query 否 MTU1NzA1NzQwMTEwMjEzMDkwCg

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

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

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

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

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。
Content-Type String application/json

内容类型。
Content-Length String 0

内容长度。
Connection String close

是否长链接。取值包括：

  • close：不是长链接，则每个HTTP请求都会重新建立TCP连接。
  • keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。
x-log-compresstype String *

压缩格式。
Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。
x-log-requestid String 5B0A6B60BB6EE39764D458B5

服务端产生的标识，该请求的唯一ID。
x-log-count String 5

当前返回数量。
x-log-bodyrawsize String 0

请求Body压缩后大小。
x-log-cursor String MTQ0NzMyOTQwMTEwMjEzMDkwNA

当前读取数据下一条Cursor。

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

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

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

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

示例

请求示例

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

正常返回示例

JSON格式

HTTP/1.1 200 OK

返回示例补充说明

如果仅进行翻页，获取下一组Token，不返回数据，可以通过HTTP HEAD方式进行请求。

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

400

ParameterInvalid

Invalid cursor.

游标参数无效。

400

ParameterInvalid

ParameterCount should be in [0-1000].

count参数取值范围应该为[0-1000]。

400

ShardNotExist

Shard does not exist.

Shard不存在。

400

InternalServerError

Specified Server Error Message.

内部服务调用错误。

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