可以根据时间获取对应的游标(Cursor)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /logstores/{logstore}/shards/{shardId}?type=cursor
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
project | string | 是 | project 名称。 | ali-test-project |
logstore | string | 是 | Logstore 名称。 | sls-test-logstore |
shardId | integer | 是 | Shard ID。 | 1 |
from | string | 是 | 时间点(Unix 时间戳)或者字符串 | 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)
,这里的时间指的是服务端时间。更多信息,请参见数据保存时间。
返回参数
示例
正常返回示例
JSON
格式
{
"cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}
错误码
访问错误中心查看更多错误码。
HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
---|---|---|---|
400 | ParameterInvalid | ParameterInvalid | 无效参数。 |
400 | ShardNotExist | Shard ShardID does not exist. | Shard 不存在。 |
400 | LogStoreWithoutShard | The logstore has no shard. | Logstore 没有 Shard。 |
404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
404 | LogStoreNotExist | Logstore does not exist. | Logstore 不存在。 |
500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息,请参见通用错误码。