Queries a cursor based on a point in time.
Operation description
Usage notes
-
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
-
The following content describes the relationships among a cursor, project, Logstore, and shard:
- A project can have multiple Logstores.
- A Logstore can have multiple shards.
- You can use a cursor to obtain a log in a shard.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| log:GetCursorOrData | get | *LogStore acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
| none |
Request syntax
GET /logstores/{logstore}/shards/{shardId}?type=cursor HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| project | string | Yes | The name of the project. | ali-test-project |
| logstore | string | Yes | The name of the Logstore. | sls-test-logstore |
| shardId | integer | Yes | The shard ID. | 1 |
| from | string | Yes | The point in time that you want to use to query a cursor. Set the value to a UNIX timestamp or a string such as | begin |
You can use the from parameter to locate a log in a shard within the lifecycle of a Logstore. If the lifecycle of a Logstore is [begin_time, end_time) and the from parameter is set to from_time, the cursor that is returned varies based on the following conditions:
from_time ≤ begin_time or from_time = "begin": The cursor that corresponds to begin_time is returned.from_time ≥ end_time or from_time = "end": The cursor that corresponds to the next log to be written based on the current time is returned. The cursor currently points to no data.from_time > begin_time and from_time < end_time: The cursor that corresponds to the first packet received by the server later than or at from_time is returned.
2018-11-11 09:00:00, and the value of the TTL field of the Logstore is 5. The data in each shard of the Logstore can be consumed within the time range [2018-11-05 09:00:00, 2018-11-11 09:00:00). The time range is determined based on the time on the server side. For more information, see the Data Retention Period parameter in the Manage a Logstore topic.
Response parameters
Examples
Sample success responses
JSONformat
{
"cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}Error codes
For a list of error codes, visit the Service error codes.