指定されたプロジェクトの Logstore から生ログデータを照会し、指定された時間範囲内の生ログを返します。結果は送信前に圧縮されます。
操作説明
-
使用時に圧縮メソッドを指定してください。プログラミング言語によって実装される圧縮アルゴリズムが異なります。詳細については、Accept-Encoding リクエストパラメーターを参照してください。
-
詳細については、 GetLogs を参照してください。
認証
次の表は、この API に必須の認可情報を示しています。この情報を RAM アクセスポリシー文の Action 要素に追加することで、Resource Access Management (RAM) ユーザーまたは RAM ロールにこの API を呼び出す権限を付与できます。
| 操作 | リソース |
log:GetLogStoreLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
この API の使用プロシージャは以下のとおりです:
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /logstores/{logstore}/logs HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| logstore |
string |
必須 |
Logstore 名。 |
test-logstore |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| project |
string |
必須 |
プロジェクト名。 |
ali-test-project |
| Accept-Encoding |
string |
任意 |
応答コンテンツの圧縮メソッド。SDK ユーザーは、SDK が自動的に圧縮と展開を処理するため、このパラメーターを指定する必要はありません。
列挙値:
|
lz4 |
| body |
object |
任意 |
リクエスト構造体。 |
|
| from |
integer |
必須 |
クエリの開始時刻。この時刻はログデータの書き込み時に指定されたログ時刻を指します。 from と to のリクエストパラメーターで定義される時間範囲は左閉右開の原則に従います。時間範囲には開始時刻が含まれますが、終了時刻は含まれません。from と to の値が同じ場合、時間範囲は無効であり、関数はエラーを返します。 値は 1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過秒数を表す UNIX タイムスタンプです。 |
1627268185 |
| to |
integer |
必須 |
クエリの終了時刻。この時刻はログデータの書き込み時に指定されたログ時刻を指します。 from と to のリクエストパラメーターで定義される時間範囲は左閉右開の原則に従います。時間範囲には開始時刻が含まれますが、終了時刻は含まれません。from と to の値が同じ場合、時間範囲は無効であり、関数はエラーを返します。 値は 1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過秒数を表す UNIX タイムスタンプです。 |
1627268185 |
| line |
integer |
任意 |
返すログの最大数。このパラメーターは query クエリパラメーターがクエリ文 (分析文ではない) の場合にのみ有効です。最小値: 0。最大値: 100。デフォルト値: 100。 |
100 |
| offset |
integer |
任意 |
クエリを開始する行。このパラメーターは query クエリパラメーターがクエリ文 (分析文ではない) の場合にのみ有効です。値は 0 から始まります。デフォルト値: 0。 |
0 |
| reverse |
boolean |
任意 |
ログタイムスタンプの逆時系列順 (分レベルの精度) でログを返すかどうかを指定します。このパラメーターは query クエリパラメーターがクエリ文 (分析文ではない) の場合にのみ有効です。
分析文で結果をソートするには、ORDER BY 構文を使用してください。ORDER BY が asc (デフォルト) にセットされている場合、ログは昇順で返されます。ORDER BY が desc にセットされている場合、ログは降順で返されます。 |
false |
| powerSql |
boolean |
任意 |
専用 SQL を有効にするかどうかを指定します。デフォルトでは無効です。 |
false |
| session |
string |
任意 |
クエリパラメーター。 |
mode=scan |
| topic |
string |
任意 |
トピック。デフォルト値: 空文字列。 |
"" |
| query |
string |
任意 |
クエリ文または分析文。詳細については、クエリの概要 および 分析の概要 を参照してください。 専用 SQL を使用するには、query クエリパラメーターの分析文に set 会話 parallel_sql=true; を追加します。例: * | set 会話 parallel_sql=true; select count(*) as pv。 注: query クエリパラメーターに分析文 (SQL ステートメント) が含まれている場合、この API の line およびオフセットパラメーターは無効です。これらを 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 |
| 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。 |
{term=*, key=} |
|
| limited |
integer |
行数の制限。SQL ステートメントに LIMIT 句が含まれていない場合に返されます。 |
100 |
| mode |
integer |
クエリモード。有効な値:
|
0 |
| phraseQueryInfo |
object |
フレーズクエリ情報。 |
|
| scanAll |
boolean |
すべてのログがスキャンされたかどうかを示します。 |
true |
| beginOffset |
integer |
インデックスフィルタリング後のスキャン結果の開始オフセット。 |
0 |
| endOffset |
integer |
インデックスフィルタリング後のスキャン結果の終了オフセット。 |
0 |
| endTime |
integer |
インデックスフィルタリング後のスキャン結果の終了時間。 |
1 |
| scanBytes |
integer |
スキャン中にスキャンされたデータ量 (バイト単位)。 |
1024 |
| highlights |
array<object> |
ハイライトされたコンテンツ。 |
|
|
object |
ハイライトされたコンテンツ。 |
||
| 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": [
{
"test": "test",
"test2": 1
}
],
"count": 1,
"processedBytes": 10000,
"isAccurate": true,
"columnTypes": [
"long"
],
"telementryType": "None"
},
"data": [
{
"key": "{'remote_addr': '198.51.XXX.XXX', 'pv': '1', '__source__': '', '__time__': '1649902984'}"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。