PullLogs_日志服务_API文档-阿里云OpenAPI开发者门户

接口说明

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作
暂无数据

请求语法

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

路径参数

字段名称	字段详情
projectstring	Project 名称。示例值:ali-test-project参考取值来源: GetProject ListProject
logStorestring	Logstore 名称。示例值:ali-test-logstore 参考取值来源: GetLogStore
shardIdinteger<int32>	日志库的分片 id。示例值:1

请求参数

字段名称	字段详情
cursorstring	游标，表示从什么位置开始读取数据，相当于起点。示例值:MTQ0NzMyOTQwMTEwMjEzMDkwNA参考取值来源: GetCursor
countinteger<int32>	返回的 Loggroup 数目，最小值为 1，最大值为 1000。示例值:1000取值 <= 1000
end_cursorstring	结束游标，表示读取数据到什么地方结束，相当于终点。示例值:MTU1NzA1NzQwMTEwMjEzMDkwCg
querystring	过滤语句，spl 语法，请参见 SPL 指令示例值:* \| where userId='123'
Accept-Encodingstring	期望服务端返回的数据压缩格式，支持 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

返回参数

字段名称	字段详情
logGroupListarray<LogGroup>	logGroup 列表

返回说明

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

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

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

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

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-09-06	新增OpenAPI，拉取日志