You need to enable JavaScript to run this app.
导航

ConsumeLogs

最近更新时间2023.11.13 16:31:27

首次发布时间2022.05.11 11:26:48

通过 ConsumeLogs 接口消费日志。

使用说明

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

说明

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

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

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/ConsumeLogs

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

TopicId

String

必选

xxxx-xxxx-xxxx-xxx

要消费日志的日志主题 ID。

ShardId

Integer

必选

0

消费的日志主题分区的 ID。您可以通过 DescribeShardId 接口获取指定主题的分区列表。

Body请求参数

参数
参数类型
是否必选
示例值
说明

Cursor

String

必选

MT*****

游标,表示从什么位置开始读取数据,相当于起点。

EndCursor

String

可选

MT*****

结束游标,表示读取数据到什么地方结束,相当于终点。EndCursor为空则不设end。

LogGroupCount

Integer

可选

1000

想要返回的最大 logGroup 数量。最多 1000 个。

Compression

String

可选

lz4

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

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

响应参数

响应头中返回数据如下。

参数
类型
示例值
描述

X-Tls-Cursor

String

MC****

当前读取数据下一条 Cursor。

X-Tls-Count

String

30

本次读取的 logGroup 数量。

示例

请求示例

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
...
pb格式数据

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InvalidCursor

400

specified Cursor is invalid.

游标不合法。

TopicNotExist

404

TopicNotExist

日志主题不存在。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码