GetCursor - - Alibaba Cloud ドキュメントセンター

操作説明

説明

ホストは、プロジェクト名と Simple Log Service エンドポイントで構成されます。ホストにプロジェクト名を指定する必要があります。
カーソル、プロジェクト、Logstore、およびシャード間の関係は次のとおりです。
- プロジェクトには複数の Logstore が含まれます。
- 各 Logstore には複数のシャードが含まれます。
- カーソルは特定のログの位置を示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは 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

パスパラメータ

パラメーター	型	必須 / 任意	説明	例
logstore	string	必須	Logstore 名。	sls-test-logstore
shardId	integer	必須	シャード ID。	1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクト名。	ali-test-project
from	string	必須	時点。UNIX タイムスタンプ、または文字列 `begin` もしくは `end` を指定できます。	begin

from パラメーターを使用して、シャードのライフサイクル内のログを検索できます。Logstore のライフサイクルが [begin_time,end_time) で、from パラメーターが from_time に設定されている場合、動作は次のようになります。

from_time が begin_time 以下の場合、または from_time が 'begin' に設定されている場合、begin_time の位置のカーソルが返されます。
from_time が end_time 以上の場合、または from_time が 'end' に設定されている場合、次のログが書き込まれる位置のカーソルが返されます。このカーソル位置にはデータは存在しません。
from_time が begin_time より大きく end_time より小さい場合、サーバー受信時刻が from_time 以上の最初のデータパケットのカーソルが返されます。

説明

Logstore のライフサイクルは、そのプロパティの TTL フィールドで指定されます。たとえば、現在時刻が 2018-11-11 09:00:00 で TTL が 5 の場合、各シャードで消費できるデータの時間範囲は [2018-11-05 09:00:00,2018-11-11 09:00:00) です。この時間はサーバー時間を指します。詳細については、「データ保持期間」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	カーソル値。
cursor	string	カーソル値。	MTQ0NzI5OTYwNjg5NjYzMjM1Ng==

例

成功レスポンス

JSONJSON

{
  "cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。