調用GetContextLogs介面查詢指定日誌前(上文)後(下文)的若干條日誌。
介面說明
介面說明
上下文查詢的時間範圍為起始日誌的前後一天。
Host 由 Project 名稱和Log Service Endpoint 構成,您需要在 Host 中指定 Project。
已建立並擷取 AccessKey。更多資訊,請參見存取金鑰。
阿里雲帳號 AccessKey 擁有所有 API 的存取權限,風險很高。強烈建議您建立並使用 RAM 使用者進行 API 訪問或日常營運。RAM 使用者需具備動作記錄服務資源的許可權。具體操作,請參見建立 RAM 使用者及授權。
已明確您查詢日誌所屬的 Project 名稱、所屬地區、Logstore 名稱等。如何查詢,請參見管理 Project和管理 Logstore。
查詢日誌前,已配置索引。具體操作,請參見建立索引。
pack_id 和 pack_meta 欄位屬於內部欄位,在執行查詢前,您需要在Log Service控制台通過瀏覽器的調試功能擷取欄位值。
鑒權資源
下表列出了 API 對應的授權資訊。您可以在 RAM 權限原則語句的 Action 元素中添加該資訊,用於為 RAM 使用者或 RAM 角色授予調用此 API 的許可權。
| 動作(Action) | 授權策略中的資源描述方式(Resource) |
log:GetLogStoreContextLogs | acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName} |
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
GET /logstores/{logstore}?type=context_log HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| logstore |
string |
是 |
Logstore 名稱。 |
test-logstore |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
是 |
Project 名稱。 |
ali-test-project |
| pack_id |
string |
是 |
起始日誌所屬的 LogGroup 的唯一身份標識。 |
85C897C740352DC6-808 |
| pack_meta |
string |
是 |
起始日誌在對應 LogGroup 內的唯一上下文結構標識。 |
2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0 |
| back_lines |
integer |
是 |
指定起始日誌往前(上文)的日誌條數,取值範圍為 |
10 |
| forward_lines |
integer |
是 |
指定起始日誌往後(下文)的日誌條數,取值範圍為 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| total_lines |
integer |
返回的總日誌條數,包含請求參數中所指定的起始日誌。 |
201 |
| back_lines |
integer |
向前查詢到的日誌條數。 |
100 |
| forward_lines |
integer |
向後查詢到的日誌條數。 |
100 |
| progress |
string |
查詢的結果是否完整。
|
Complete |
| logs |
array<object> |
擷取到的日誌。 |
|
|
object |
擷取到的日誌,按上下文順序排列。當根據指定起始日誌查詢不到上下文日誌時,此參數為空白。 |
{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"} |
logs 中的每一項都是該日誌的內容(索引值對),除使用者日誌內容外,還包含三個欄位,具體如下:
| 參數名稱 | 資料類型 | 樣本值 | 描述 |
__index_number__ | String | -100 | 該日誌在本次查詢結果中相對內容相關的位置,負數表示上文,0 表示起始日誌,正數表示下文。例如:-100 表示起始日誌往前的第 100 條日誌。 |
__tag__:__pack_id__ | String | 895CEA449A52FE-8c8 | 該日誌所屬的 LogGroup 的唯一身份標識,可作為請求參數中的 pack_id 進行查詢。 |
__pack_meta__ | String | 0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1 | 該日誌在所屬 LogGroup 內的唯一上下文結構標識,可作為請求參數中的 pack_meta 進行查詢。 |
樣本
正常返回樣本
JSON格式
{
"total_lines": 201,
"back_lines": 100,
"forward_lines": 100,
"progress": "Complete",
"logs": [
{
"__index_number__": "-100",
"__tag__:__pack_id__": "895CEA449A52FE-8c8",
"__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。