閱讀816 返回首頁    go 財經資訊


GetCursor__日誌庫相關接口_API-Reference_日誌服務-阿裏雲

GetCursor 根據時間獲得遊標(Cursor),下圖表示Project,LogStore, Shard 與 Cursor關係:

  • Project下有多個logstore
  • 每個logstore會有多個shard
  • 通過cursor可以獲得特定日誌對應的位置

請求語法

GET /logstores/ay42/shards/2?type=cursor&from=1402341900 HTTP/1.1
Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0

請求參數

參數名稱 類型 是否必須 描述
shard string
type string 此處為"cursor"
from string 時間點(UNIX下秒數), 或"begin","end"
LogStore生命周期:

Logstore生命周期由屬性中lifeCycle字段指定,例如當前時間為2015-11-11 09:00:00,lifeCycle=24。則每個shard中可以消費的數據時間段為[2015-11-10 09:00:00,2015-11-11 09:00:00),這裏的時間指的是Server端時間。

通過from關可以在shard中定位生命周期內的日誌,假設Logstore生命周期為[begin_time,end_time),from=from_time

 from_time <= begin_time or from_time == "begin" : 返回時間點為begin_time對應的cursor位置
 from_time >= end_time or from_time == "end" : 返回當前時間點下,下一條將被寫入的cursor位置(當前該cursor位置上無數據)
 from_time > begin_time and from_time < end_time : 返回第一個服務端接收時間 >= from_time的數據包對應的cursor

請求頭

無特有請求頭,關於API的公共請求頭請參考公共請求頭

響應頭

無特有響應頭,關於API的公共響應頭請參考公共響應頭

響應元素

{
    "cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}

細節描述

錯誤碼

除了返回API的通用錯誤碼,還可能返回如下特有錯誤碼:

HTTP狀態碼 ErrorCode ErrorMessage
404 LogStoreNotExist Logstore {Name} not exist
400 ParameterInvalid Parameter From is not valid
400 ShardNotExist Shard {ShardID} not exist
500 InternalServerError Specified Server Error Message
400 LogStoreWithoutShard the logstore has no shard

示例

請求示例:
GET /logstores/sls-test-logstore/shards/0?type=cursor&from=begin
Header:
{
    "Content-Length": 0, 
    "x-log-signaturemethod": "hmac-sha1", 
    "x-log-bodyrawsize": 0, 
    "User-Agent": "log-python-sdk-v-0.6.0", 
    "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com", 
    "Date": "Thu, 12 Nov 2015 03:56:57 GMT", 
    "x-log-apiversion": "0.6.0", 
    "Content-Type": "application/json", 
    "Authorization": "LOG 94to3z418yupi6ikawqqd370:+vo0Td6PrN0CGoskJoOiAsnkXgA="
}
響應示例:
Header:
{
    "content-length": "41", 
    "server": "nginx/1.6.1", 
    "connection": "close", 
    "date": "Thu, 12 Nov 2015 03:56:57 GMT", 
    "content-type": "application/json", 
    "x-log-requestid": "56440E0999248C070600C6AA"
}
Body:
{
    "cursor": "MTQ0NzI5OTYwNjg5NjYzMjM1Ng=="
}

最後更新:2016-11-23 16:04:02

  上一篇:go DeleteShard__日誌庫相關接口_API-Reference_日誌服務-阿裏雲
  下一篇:go PullLogs__日誌庫相關接口_API-Reference_日誌服務-阿裏雲