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

接口说明

Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
Cursor 与 Project、Logstore、Shard 的关系如下：
- Project 下有多个 Logstore。
- 每个 Logstore 会有多个 Shard。
- 通过 Cursor 可以获得特定日志对应的位置。

流控信息

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

授权信息

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

具体说明如下：展开详情

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

log:GetCursorOrData	Get	LogStore acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}	log:TLSVersion	无

请求语法

GET /logstores/{logstore}/shards/{shardId}?type=cursor HTTP/1.1

路径参数

字段名称	字段详情
logstorestring	Logstore 名称。示例值:sls-test-logstore
shardIdinteger<int32>	Shard ID。示例值:1

请求参数

字段名称	字段详情
projectstring	project 名称。示例值:ali-test-project
fromstring	时间点（Unix 时间戳）或者字符串`begin`、`end`。示例值:begin

请求说明

通过 from 可以在 Shard 中定位生命周期内的日志，假设 Logstore 的生命周期为[begin_time,end_time)，from=from_time，那么：

当from_time ≤ begin_time or from_time = "begin"时：返回时间点为 begin_time 对应的 Cursor 位置。
当from_time ≥ end_time or from_time = "end"时：返回当前时间点下一条将被写入的 Cursor 位置（当前该 Cursor 位置上无数据）。
当from_time > begin_time and from_time < end_time时：返回第一个服务端接收时间大于等于 from_time 的数据包对应的 Cursor。

说明 Logstore 生命周期由属性中 TTL 字段指定。例如，当前时间为2018-11-11 09:00:00，TTL=5。则每个 Shard 中可以消费的数据时间段为 [2018-11-05 09:00:00,2018-11-11 09:00:00)，这里的时间指的是服务端时间。更多信息，请参见数据保存时间。

返回参数

字段名称	字段详情
cursorstring	Cursor 值。示例值:MTQ0NzI5OTYwNjg5NjYzMjM1Ng==

返回示例

变更历史

暂无变更历史