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

查詢日誌投遞任務狀態。

請求語法

GET /logstores/{logstoreName}/shipper/{shipperName}/tasks?from=1448748198&to=1448948198&status=success&offset=0&size=100 HTTP/1.1
Authorization: <AuthorizationString> 
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1

請求參數

參數名稱	類型	是否必須	描述
logstoreName	string	是	日誌庫名稱，同一Project下唯一
shipperName	string	是	日誌投遞規則名稱，同一logstore下唯一
from	integer	是	日誌投遞任務創建時間區間
to	integer	是	日誌投遞任務創建時間區間
status	string	否	默認為空，表示返回所有狀態的任務，目前支持“success/fail/running”等狀態
offset	integer	否	返回指定時間區間內投遞任務的起始數目，默認值為0
size	integer	否	返回指定時間區間內投遞任務的數目，默認值為100，最大為500

請求頭

GetShipperStatus接口無特有請求頭，關於Log Service API的公共請求頭請參考公共請求頭。

響應頭

GetShipperStatus接口無特有響應頭，關於Log Service API的公共響應頭請參考公共響應頭。

響應元素

請求成功，其響應Body會包括指定指定日誌投遞任務列表：

{
    "count" : 10,
    "total" : 20,
    "statistics" : {
        "running" : 0,
        "success" : 20,
        "fail" : 0 
    }
    "tasks" : [
        {
            "id" : "abcdefghijk",
            "taskStatus" : "success",
            "taskMessage" : "",
            "taskCreateTime" : 1448925013,
            "taskLastDataReceiveTime" : 1448915013,
            "taskFinishTime" : 1448926013
        }
    ]
}

名稱	類型	描述
count	integer	返回的任務個數。
total	integer	指定範圍內任務總數。
statistics	json	指定範圍內任務匯總狀態，具體請參考下表。
tasks	array	指定範圍內投遞任務具體詳情，具體請參考下表。

statistics內容

名稱	類型	描述
running	integer	指定範圍內狀態為“running”的任務個數。
success	integer	指定範圍內狀態為“success”的任務個數。
fail	integer	指定範圍內狀態為“fail”的任務個數。

tasks內容

名稱	類型	描述
id	string	具體投遞任務的任務唯一id。
taskStatus	string	投遞任務的具體狀態，可能為"running/success/fail"中的一種。
taskMessage	string	投遞任務失敗時具體錯誤信息。
taskCreateTime	integer	投遞任務創建時間。
taskLastDataReceiveTime	integer	投遞任務中的最新日誌數據時間。
taskFinishTime	integer	投遞任務結束時間。

錯誤碼

除了返回Log Service API的通用錯誤碼，還可能返回如下特有錯誤碼：

HTTP狀態碼	ErrorCode	ErrorMessage
404	ProjectNotExist	Project {ProjectName} not exist
404	LogStoreNotExist	logstore {logstoreName} not exist
400	ShipperNotExist	shipper {logstoreName} not exist
500	InternalServerError	internal server error
400	ParameterInvalid	start time must litter than end time
400	ParameterInvalid	only support query last 48 hours task status
400	ParameterInvalid	status only contains success/running/fail

細節描述

投遞任務狀態查詢時間區間隻能指定為最近24小時之內。

請求示例：

GET /logstores/test-logstore/shipper/test-shipper/tasks?from=1448748198&to=1448948198&status=success&offset=0&size=100 HTTP/1.1
Header:
{
x-log-apiversion=0.6.0, 
Authorization=LOG 94to3z418yupi6ikawqqd370:wFcl3ohVJupCi0ZFxRD0x4IA68A=, 
Host=ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com, 
Date=Wed, 11 Nov 2015 08:28:19 GMT, 
Content-Length=55, 
x-log-signaturemethod=hmac-sha1, 
Content-MD5=757C60FC41CC7D3F60B88E0D916D051E, 
User-Agent=sls-java-sdk-v-0.6.0, 
Content-Type=application/json
}

響應示例：

HTTP/1.1 200 OK
Header:
{
Date=Wed, 11 Nov 2015 08:28:20 GMT, 
Content-Length=0, 
x-log-requestid=5642FC2399248C8F7B0145FD, 
Connection=close, 
Server=nginx/1.6.1
}
Body:
{
    "count" : 10,
    "total" : 20,
    "statistics" : {
        "running" : 0,
        "success" : 20,
        "fail" : 0 
    }
    "tasks" : [
        {
            "id" : "abcdefghijk",
            "taskStatus" : "success",
            "taskMessage" : "",
            "taskCreateTime" : 1448925013,
            "taskLastDataReceiveTime" : 1448915013,
            "taskFinishTime" : 1448926013
        }
    ]
}

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

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

請求語法

請求參數

請求頭

響應頭

響應元素

錯誤碼

細節描述

請求示例：

響應示例：

上一篇： PostLogStoreLogs__日誌庫相關接口_API-Reference_日誌服務-阿裏雲

下一篇： RetryShipperTask__日誌庫相關接口_API-Reference_日誌服務-阿裏雲

相關內容

熱門內容

最新內容