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

指定されたプロジェクトの Logstore から生ログをクエリします。応答には、指定された時間範囲内の生ログが含まれており、伝送用に圧縮されています。

操作説明

Simple Log Service ソフトウェア開発キット (SDK) は、Go、Java、Python で利用できます。すべての OpenAPI 操作を直接呼び出すこともできます。
この操作を呼び出す際に、圧縮方法を指定してください。利用可能な圧縮アルゴリズムは、ご利用のプログラミング言語によって異なります。詳細については、Accept-Encoding リクエストパラメーターをご参照ください。
詳細については、「GetLogs」をご参照ください。

権限

次の表に、この API 操作を呼び出すために必要な権限を示します。RAM ユーザーまたは RAM ロールにこの操作を呼び出す権限を付与するには、アクションを RAM ポリシーステートメントに追加します。

アクション	権限付与ポリシーのリソース
`log:GetLogStoreLogs`	`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`

今すぐお試しください

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

テスト

RAM 認証

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

リクエスト構文

POST /logstores/{logstore}/logs HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
logstore	string	必須	Logstore の名前。	test-logstore

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクトの名前。	ali-test-project
Accept-Encoding	string	必須	圧縮方法。 Java、Python、Go は lz4 および gzip 展開をサポートしています。 PHP、JavaScript、C# は gzip 展開のみをサポートしています。列挙値: lz4 : lz4 gzip : gzip	lz4
body	object	任意	リクエスト構造体。
from	integer	必須	クエリする時間範囲の開始。値はログが書き込まれたときに指定されたログ時間です。時間範囲は左閉右開区間です。これは、範囲に開始時刻は含まれますが、終了時刻は含まれないことを意味します。from と to の値が同じ場合、間隔は無効となり、エラーが返されます。値は、1970 年 1 月 1 日 00:00:00 UTC からの秒数を表す UNIX タイムスタンプです。	1627268185
to	integer	必須	クエリする時間範囲の終了。値はログが書き込まれたときに指定されたログ時間です。時間範囲は左閉右開区間です。これは、範囲に開始時刻は含まれますが、終了時刻は含まれないことを意味します。from と to の値が同じ場合、間隔は無効となり、エラーが返されます。値は、1970 年 1 月 1 日 00:00:00 UTC からの秒数を表す UNIX タイムスタンプです。	1627268185
line	integer	任意	返されるログの最大数。このパラメーターは、クエリパラメーターにクエリ文が含まれている場合にのみ有効です。値は 0 から 100 までの整数である必要があります。デフォルト値は 100 です。	100
offset	integer	任意	クエリを開始する行番号。このパラメーターは、クエリパラメーターにクエリ文が含まれている場合にのみ有効です。デフォルト値は 0 です。	0
reverse	boolean	任意	ログをタイムスタンプの降順で返すかどうかを指定します。精度は分レベルです。 true: ログをタイムスタンプの降順で返します。false (デフォルト): ログをタイムスタンプの昇順で返します。注:クエリパラメーターにクエリ文が含まれている場合、reverse パラメーターは有効であり、ソート順を指定します。クエリパラメーターにクエリおよび分析文が含まれている場合、reverse パラメーターは無効です。ソート順は、分析文の ORDER BY 句によって指定されます。ORDER BY が asc (デフォルト) の場合、ログは昇順でソートされます。ORDER BY が desc の場合、ログは降順でソートされます。	false
powerSql	boolean	任意	拡張 SQL を有効にするかどうかを指定します。デフォルト値は false です。	false
session	string	任意	クエリパラメーター。	mode=scan
topic	string	任意	ログ Topic。デフォルト値は二重引用符 ("") です。	""
query	string	任意	クエリ文または分析文。詳細については、「クエリ概要」および「分析概要」をご参照ください。排他的 SQL 機能を使用するには、クエリパラメーターの分析文に set session parallel_sql=true; を追加します。例: * \| set session parallel_sql=true; select count(*) as pv。注: クエリパラメーターに分析文 (SQL 文) が含まれている場合、line および offset パラメーターは無効です。これらを 0 に設定してください。ページングには、SQL 文の LIMIT 句を使用します。詳細については、「クエリおよび分析結果のページング」をご参照ください。	status: 401 \| SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5
forward	boolean	任意	スキャンまたはフレーズクエリの場合、順方向または逆方向にページングするかどうかを指定します。	false
highlight	boolean	任意	結果をハイライトするかどうかを指定します。	false
isAccurate	boolean	任意	ナノ秒レベルのソートを有効にするかどうかを指定します。	true

レスポンスフィールド

フィールド	型	説明	例
	object	返されるデータです。
meta	object	返されたデータのメタデータ。
progress	string	クエリの進捗。有効な値: Complete: クエリは完了し、返された結果は完全です。 Incomplete: クエリは完了しましたが、返された結果は不完全です。完全な結果を取得するには、リクエストを再送信する必要があります。	Complete
aggQuery	string	パイプ文字 (\|) の後に続くクエリ文の SQL 部分。	select *
whereQuery	string	パイプ文字 (\|) の前に続くクエリ文の部分。	*
hasSQL	boolean	クエリが SQL クエリであるかどうかを示します。	false
processedRows	integer	クエリで処理された行数。	10000
elapsedMillisecond	integer	クエリによって消費された時間 (ミリ秒単位)。	5
cpuSec	number	排他的 SQL のコア時間。	0.002
cpuCores	integer	使用された CPU コア数。	3
keys	array	クエリ結果内のすべてのキー。
	string	キー。	key
terms	array<object>	クエリ文内のすべての term。
	object	用語。	{term=*, key=}
limited	integer	返されたエントリ数。このパラメーターは、SQL 文に LIMIT 句が含まれていない場合に返されます。	100
mode	integer	クエリモード。有効な値:0: 通常クエリ (SQL クエリを含む)。1: フレーズクエリ。2: SCAN クエリ。3: SCAN SQL クエリ。	0
phraseQueryInfo	object	フレーズクエリに関する情報。
scanAll	boolean	すべてのログがスキャンされたかどうかを示します。	true
beginOffset	integer	インデックスフィルタリング後のスキャン結果の開始オフセット。	0
endOffset	integer	インデックスフィルタリング後のスキャン結果の終了オフセット。	0
endTime	integer	インデックスフィルタリング後のスキャン結果の終了時刻。	1
scanBytes	integer	スキャンクエリでスキャンされたデータ量 (バイト単位)。	1024
highlights	array	ハイライトされたコンテンツ。
	array	ハイライトされたコンテンツ。
	LogContent	ハイライトされたログコンテンツ。
count	integer	このクエリで返されたログエントリ数。	1
processedBytes	integer	クエリで処理されたログ量 (バイト単位)。	10000
isAccurate	boolean	ナノ秒レベルのソートが有効になっているかどうかを示します。	true
columnTypes	array	カラムタイプ。
	string	タイプ。	long
telementryType	string	観測可能データのタイプ。	None
data	array<object>	クエリ結果。
	object	返されたデータ。
	string	返されたデータ。	{'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}

例

成功レスポンス

JSONJSON

{
  "meta": {
    "progress": "Complete",
    "aggQuery": "select *",
    "whereQuery": "*",
    "hasSQL": false,
    "processedRows": 10000,
    "elapsedMillisecond": 5,
    "cpuSec": 0.002,
    "cpuCores": 3,
    "keys": [
      "key"
    ],
    "terms": [
      {
        "test": "test",
        "test2": 1
      }
    ],
    "limited": 100,
    "mode": 0,
    "phraseQueryInfo": {
      "scanAll": true,
      "beginOffset": 0,
      "endOffset": 0,
      "endTime": 1
    },
    "scanBytes": 1024,
    "highlights": [
      [
        {
          "Key": "key-test",
          "Value": "value-test"
        }
      ]
    ],
    "count": 1,
    "processedBytes": 10000,
    "isAccurate": true,
    "columnTypes": [
      "long"
    ],
    "telementryType": "None"
  },
  "data": [
    {
      "key": "{'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}"
    }
  ]
}

エラーコード

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

変更履歴

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