PullLogs API で Protocol Buffer 形式のシャードログを取得 - SLS - Alibaba Cloud - Simple Log Service

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

パスパラメーター

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

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクト名。	ali-test-project
cursor	string	必須	データの読み取り開始位置を示すカーソル。	MTQ0NzMyOTQwMTEwMjEzMDkwNA
count	integer	必須	返されるロググループの最大数。最小値: 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

レスポンスフィールド

フィールド	型	説明	例
	LogGroupList	圧縮された Protocol Buffer データ。

次の応答要素は PullLogs 操作に固有のものです。

x-log-cursor: 現在のデータ読み取り後の次のエントリのカーソル。
x-log-end-of-cursor: 現在のデータ読み取りの最後のエントリのカーソル。
x-log-count: 返されるエントリ数。

Simple Log サービス API の共通応答ヘッダーの詳細については、共通応答ヘッダーを参照してください。

応答要素は Protocol Buffer フォーマットでシリアル化されたデータであり、圧縮されている場合があります。

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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