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

PullLogs 操作を呼び出して、指定されたカーソル位置からログデータを取得します。この操作は未加工のログを取得します。ログをクエリまたは分析するには、GetLogsV2 操作を呼び出します。

操作説明

警告この操作は OpenAPI SDK ではサポートされていません。Simple Log Service SDK を使用してください。

ログを取得するシャードを指定します。
この操作は、Protocol Buffer フォーマットのデータ読み取りのみをサポートします。
リクエスト構文の Host は、プロジェクト名と Simple Log Service エンドポイントで構成されます。Host にプロジェクトを指定します。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET /logstores/{logStore}/shards/{shardId}?type=log HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクト名。	ali-test-project
logStore	string	必須	Logstore の名前。	ali-test-logstore
shardId	integer	必須	Logstore 内のシャードの ID。	1
cursor	string	必須	データの読み取りを開始する開始位置を指定するカーソル。	MTQ0NzMyOTQwMTEwMjEzMDkwNA
count	integer	必須	返す LogGroup の数。値は 1 から 1000 までの整数である必要があります。	1000
end_cursor	string	任意	データの読み取りを停止する終了位置を指定するカーソル。	MTU1NzA1NzQwMTEwMjEzMDkwCg
query	string	任意	構造化プロセス言語 (SPL) 構文のフィルターステートメント。詳細については、「SPL 命令」をご参照ください。	* \| where userId='123'
Accept-Encoding	string	任意	サーバーが返すデータの圧縮フォーマット。lz4 フォーマットのみがサポートされています。	lz4

次のリクエストヘッダーは PullLogs 操作に固有です。

Accept: application/x-protobuf
Accept-Encoding: lz4

Accept-Encoding の値は lz4、deflate、または二重引用符 ("") にすることができます。

リクエストの例:

GET /logstores/sls-test-logstore/shards/0?type=logs&cursor=MTQ0NzMyOTQwMTEwMjEzMDkwNA&count=1000 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

レスポンスフィールド

フィールド	型	説明	例
headers	object
Content-Length	string		0
Date	string		Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string		5B0A6B60BB6EE39764D458B5
x-log-count	string
x-log-cursor	string
x-log-cursor-time	string
x-log-end-of-cursor	string
Content-Type	string		application/json
x-log-compresstype	string
x-log-bodyrawsize	string
	LogGroupList	protobuf フォーマットの圧縮データ。

次のレスポンスヘッダーは PullLogs 操作に固有です。

x-log-cursor: 読み取る次のログのカーソル。
x-log-end-of-cursor: 現在のリクエストで読み取られる最後のログのカーソル。
x-log-count: 返されたログの数。

Simple Log Service API 操作の共通レスポンスヘッダーの詳細については、「共通レスポンスヘッダー」をご参照ください。

レスポンス本文には、protobuf フォーマットでシリアル化されたデータが含まれています。データは圧縮されている場合があります。

例

成功レスポンス

JSONJSON

{
  "logGroupList": [
    {
      "Topic": "topic-test",
      "Source": "192.1.1.1",
      "LogTags": [
        {
          "Key": "key-test",
          "Value": "value-test"
        }
      ],
      "LogItems": [
        {
          "Time": 1690254376,
          "Contents": [
            {
              "Key": "key-test",
              "Value": "value-test"
            }
          ]
        }
      ]
    }
  ]
}

エラーコード

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

変更履歴

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