文档中心

日志服务

请输入

日志管理

ConsumeLogs

本接口通过游标（Cursor）和数量（Count），消费指定日志主题分区的日志数据。

使用说明

ConsumeLogs 接口通过游标（Cursor）和数量（Count），消费指定日志主题分区的日志数据。

ConsumeLogs 接口响应消息的 Content-Type 为 application/x-protobuf，即在响应信息中返回 PB 格式数据。日志服务 PB 格式请参考数据编码方式。

ConsumeLogs 接口的调用频率限制为 100 次/s，超出频率限制会报错 ExceedQPSLimit；每次调用的流量限制为 5MiB，超出流量限制会报错 ExceedRateLimit。

当指定游标范围内的 LogGroup 数量超过 1000 时，本次调用将返回 NextCursor，您可以调用 ConsumeLogs 接口继续消费，直到接口读取到 EndCursor 值。

请求说明

请求方式：GET

请求地址：https://{tls-endpoint}/ConsumeLogs

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
TopicId	String	是	c7e0e442-19bf-4fb3-b547-5992fb8b****	要消费日志的日志主题 ID。
ShardId	Integer	是	0	消费的日志主题分区的 ID。您可以通过 DescribeShards 接口获取指定主题的分区列表。

Body

参数	类型	是否必选	示例值	描述
Compression	String	否	lz4	返回数据的压缩格式。目前支持lz4和zlib压缩。
Cursor	String	是	MTQ0NzMyOTQwMTEwMjEzMD****	开始游标，表示从什么位置开始读取数据，相当于起点。
EndCursor	String	否	MTU1NzA1NzQwMTEwMjEzMD****	结束游标，表示读取数据到什么地方结束，相当于终点。 EndCursor 为空则不设 end。
LogCount	Integer	否	100	每次请求返回的日志数量，用于控制单次请求获取的日志条数。
LogGroupCount	Integer	否	1000	想要返回的最大 LogGroup 数量。最多1000个。
ProcessorId	String	否	9e91e9e5-2063-4182-8eff-b7371500****	数据消费处理器 ID。通过添加消费处理器实现基于规则的数据消费功能。
Size	Integer	否	1048576	每次消费的日志数据大小，单位为字节。该参数用于限制单次请求返回的日志数据量，避免响应过大。

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

GET https://{tls-endpoint}/ConsumeLogs?&TopicId=c7e0e442-19bf-4fb3-b547-5992fb8b****&ShardId=0 HTTP/1.1​
Content-Type: application/json​
{​
    "Cursor": "MTQ0NzMyOTQwMTEwMjEzMD****",​
    "EndCursor": "MTU1NzA1NzQwMTEwMjEzMD****",​
    "LogGroupCount": 1000,​
    "Compression": "lz4"​
}​

返回示例

Content-Type: application/json; charset=utf-8​
...​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.05.29 16:33:05

这个页面对您有帮助吗？

有用

无用