調用PullLogs接口獲取指定游標（Cursor）位置的日志數據。此接口獲取的是原始日志，如要查詢或分析日志，請使用GetLogsV2接口。
接口說明
目前 OpenAPI SDK 不支持此接口，請使用日志服務 SDK。
- 獲取日志時必須指定 Shard。
- 目前僅支持讀取Protocol Buffer格式數據。
- 請求語法中 Host 由 Project 名稱和日志服務 Endpoint 構成，您需要在 Host 中指定 Project。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
GET /logstores/{logStore}/shards/{shardId}?type=log HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名稱。 | ali-test-project |
| logStore | string | 是 | Logstore 名稱。 | ali-test-logstore |
| shardId | integer | 是 | 日志庫的分片 id。 | 1 |
| cursor | string | 是 | 游標，表示從什么位置開始讀取數據，相當于起點。 | MTQ0NzMyOTQwMTEwMjEzMDkwNA |
| count | integer | 是 | 返回的 Loggroup 數目，最小值為 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
返回參數
PullLogs 接口的特有響應元素如下所示：
- x-log-cursor：當前讀取數據下一條 Cursor。
- x-log-end_cursor：當前讀取數據最后一條 Cursor。
- x-log-count：當前返回數量。
關于 Log Service API 的公共響應頭，請參見公共響應頭。
響應元素為 protobuf 格式序列化后的數據（可能經過壓縮）。
示例
正常返回示例
JSON格式
{
"logGroupList": [
{
"Topic": "topic-test",
"Source": "192.1.1.1",
"LogTags": [
{
"Key": "key-test",
"Value": "value-test"
}
],
"LogItems": [
{
"Time": 1690254376,
"Contents": [
{
"Key": "key-test",
"Value": "value-test"
}
]
}
]
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-09-06 | 新增 OpenAPI | 查看變更詳情 |