tencent cloud

Feature Description

This API is used to get the cursor of the corresponding topic partition based on time, which is used to get the log data on the corresponding topic partition.

Request

Sample request

GET /cursor?topic_id=xxxxxxxx-xxxx-xxxx-xxxx&partition_id=1&from=end HTTP/1.1
Host: <Region>.cls.tencentyun.com
Authorization: <AuthorizationString>

Request header

There are only common request headers but no special request headers.

Request parameters

Topic partition lifecycle description

The data lifecycle of a topic partition is set by the CLS backend and is no less than 1 day (the lifecycle of topic partition data varies by log topic).

For example, if the current time is 2019-10-10 12:00:00, the time range (based on the server time) in which data in each topic partition can be consumed is: [2019-10-09 12:00:00, 2019-10-10 12:00:00).

from can be used to locate the starting position of real-time consumption in the topic partition. If the lifecycle of the topic partition is [start_time, end_time), then:

• When from (UNIX timestamp) ≤ start_time or from = "start", the time point returned by the API will be the cursor position corresponding to start_time.
• When from (UNIX timestamp) ≥ end_time or from = "end", the API will return the next cursor position to be written at the current time point (there is no data at this cursor position currently).
• When from (UNIX timestamp) > start_time and from (UNIX timestamp) < end_time, the API will return the cursor position corresponding to the first data packet received by the server at a time after or at from (UNIX timestamp).

Response

Sample response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 23

{"cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="}

Response header

There are only common response headers but no special response headers.

Response parameters

Error Codes

For more information, please see Error Codes.