You need to enable JavaScript to run this app.
导航
ConsumeLogs
最近更新时间:2024.05.06 15:36:08首次发布时间:2022.05.11 11:26:48

通过 ConsumeLogs 接口消费日志。

使用说明

  • ConsumeLogs 接口通过游标(Cursor)和数量(Count),消费指定日志主题分区的日志数据。

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

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

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

请求说明

  • 请求方式:POST
  • 请求地址:https://tls-{Region}.ivolces.com/ConsumeLogs

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
CursorStringMT*****游标,表示从什么位置开始读取数据,相当于起点。
EndCursorStringMT*****结束游标,表示读取数据到什么地方结束,相当于终点。EndCursor 为空则不设 end。
LogGroupCountInteger1000想要返回的最大 LogGroup 数量。最大值为 1000。

Compression

String

lz4

返回数据的压缩格式。支持设置为:

  • lz4:压缩格式为 lz4。
  • zlib:压缩格式为 zlib。

    如果通过 Windows SDK 消费日志,仅支持使用 zlib 压缩格式。

返回参数

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

请求示例

GET https://tls-{Region}.ivolces.com/ConsumeLogs?TopicId=c13f36aa-3131-41c7-9862-c1fa5d0****&ShardId=0 
Content-Type: application/json
{
    "Cursor": "MC0wLTAwMD****",
    "EndCursor": "MC0wLTA****",
    "LogGroupCount": 100,
    "Compression": "lz4"
}

返回示例

HTTP/1.1 200 OK
Content-Type: application/x-protobuf
X-Tls-Cursor: MC0w****
X-Tls-Count: 30

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HTTP 状态码错误码错误信息说明
400InvalidArgumentInvalid argument key %s, value %s, please check argument.参数不合法。
400InvalidCursorspecified Cursor is invalid.游标不合法。
404TopicNotExistTopicNotExist日志主题不存在。
500InternalServerErrorWe encountered an unexpected server error, please try again later.服务器内部错误。