GetCursorTime - Simple Log Service

Retrieves the server time that corresponds to a cursor.

Operation description

Description

The host consists of a project name and a Simple Log Service endpoint. You must specify the project in the host.
Create and obtain an AccessKey pair. For more information, see AccessKey pair.

An AccessKey pair that belongs to an Alibaba Cloud account has access permissions on all API operations. Using this AccessKey pair poses a high security threat. For security, we recommend that you create and use a RAM user to call API operations or perform routine operations and maintenance (O&M). The RAM user must be granted the permissions to perform operations on Simple Log Service resources. For more information, see Create and authorize a RAM user.

Obtain the project name, the project's region, and the logstore name. For more information, see Manage a project and Manage a logstore.

Authorization

The following table describes the authorization information for this operation. Add this information to the Action element of a RAM policy to grant a RAM user or RAM role the permissions to call this API operation.

Action	Resource description in an authorization policy
`log:GetCursorOrData`	`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}`

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

log:GetCursorOrData

get

*LogStore

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

log:TLSVersion

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
logstore	string	Yes	The logstore name.	ali-test-logstore
shardId	integer	Yes	The shard ID.	0

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The project name.	ali-test-project
cursor	string	Yes	The cursor for which you want to obtain the timestamp. Call the GetCursor operation to obtain a cursor. Note If the value of the cursor is less than the begin cursor or greater than the end cursor, InvalidCursor is returned. If the shard contains no data, the current time is returned.	MTU0NzQ3MDY4MjM3NjUxMzQ0Ng==

Response elements

Element	Type	Description	Example
	object
cursor_time	string	The server time that corresponds to the cursor. The value is a UNIX timestamp. A UNIX timestamp represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.	1554260243

Examples

Success response

JSON format

{
  "cursor_time": "1554260243"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.