查詢指定Project下某個Logstore中的原始日誌資料,返回結果顯示某時間區間中的原始日誌(返回結果壓縮後傳輸)。
介面說明
-
使用過程中注意指定壓縮方法,不同語言實現的壓縮演算法不同,詳情參考入參 Accept-Encoding。
-
更多相關說明請參見 GetLogs 。
鑑權資源
下表列出了 API 對應的授權資訊。您可以在 RAM 權限策略語句的 Action 元素中添加該資訊,用於為 RAM 使用者或 RAM 角色授予呼叫此 API 的權限。
| 動作(Action) | 授權策略中的資源描述方式(Resource) |
log:GetLogStoreLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST /logstores/{logstore}/logs HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| logstore |
string |
是 |
logstore 名稱。 |
test-logstore |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
是 |
project 名稱。 |
ali-test-project |
| Accept-Encoding |
string |
否 |
返回內容的壓縮方式。sdk 使用者無需指定,由 sdk 自動處理壓縮與解壓。
枚舉值:
|
lz4 |
| body |
object |
否 |
請求結構體。 |
|
| from |
integer |
是 |
查詢開始時間點。該時間是指寫入日誌資料時指定的日誌時間。 請求參數 from 和 to 定義的時間區間遵循左閉右開原則,即該時間區間包括區間開始時間點,但不包括區間結束時間點。如果 from 和 to 的值相同,則為無效區間,函數直接返回錯誤。 Unix 時間戳格式,表示從 1970-1-1 00:00:00 UTC 計算起的秒數。 |
1627268185 |
| to |
integer |
是 |
查詢結束時間點。該時間是指寫入日誌資料時指定的日誌時間。 請求參數 from 和 to 定義的時間區間遵循左閉右開原則,即該時間區間包括區間開始時間點,但不包括區間結束時間點。如果 from 和 to 的值相同,則為無效區間,函數直接返回錯誤。 Unix 時間戳格式,表示從 1970-1-1 00:00:00 UTC 計算起的秒數。 |
1627268185 |
| line |
integer |
否 |
請求返回的最大日誌條數。僅當 query 參數為查詢語句(非 SQL 分析語句)時,該參數有效。最小值為 0,最大值為 100,預設值為 100。 |
100 |
| offset |
integer |
否 |
查詢開始行。僅當 query 參數為查詢語句(非 SQL 分析語句)時,該參數有效。值從 0 開始,預設值為 0。 |
0 |
| reverse |
boolean |
否 |
用於指定返回結果是否按日誌時間戳降序返回日誌,精確到分鐘級別。僅當 query 為查詢語句(非 SQL 分析語句)時有效。
如需在 SQL 分析語句中排序,請使用 order by 語法指定排序方式。如果 order by 為 asc(預設),則為升序;如果 order by 為 desc,則為降序。 |
false |
| powerSql |
boolean |
否 |
是否開啟獨享版 SQL,預設關閉。 |
false |
| session |
string |
否 |
查詢參數。 |
mode=scan |
| topic |
string |
否 |
日誌主題。預設值為空。 |
"" |
| query |
string |
否 |
在 query 參數的分析語句中加上 set session parallel_sql=true;,表示使用 SQL 獨享版。例如* | set session parallel_sql=true; select count(*) as pv 。 說明當 query 參數中有分析語句(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 |
否 |
scan 或短語查詢表示是否向前或向後翻頁。 |
false |
| highlight |
boolean |
否 |
是否高亮。 |
false |
| isAccurate |
boolean |
否 |
是否開啟奈秒級有序。 |
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資料。 |
||
| meta |
object |
返回資料 meta 資訊。 |
|
| 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 |
查詢結果中所有的 key。 |
|
|
string |
key |
key |
|
| terms |
array<object> |
查詢語句中所有的詞。 |
|
|
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 |
本次掃描結果對應的索引過濾後的起始 offset。 |
0 |
| endOffset |
integer |
本次掃描結果對應的索引過濾後的結束 offset。 |
0 |
| endTime |
integer |
本次掃描結果對應的索引過濾後的最後時間。 |
1 |
| scanBytes |
integer |
scan 時返回掃描的資料量(位元組)。 |
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'} |
樣本
正常返回樣本
JSON格式
{
"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'}"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。