LogShipper タスクステータスを照会します。

リクエスト構文

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 必須 同じプロジェクト内で一意の Logstore 名。
shipperName String 必須 同じ Logstore 内で一意のログ転送ルールの名前。
from integer 必須 LogShipper タスクの開始時刻。
to integer 必須 LogShipper タスクの終了時刻。
status string 省略可能 任意のステータスのタスクが返されたことを示します (デフォルトは空)。 現在、タスクは正常状態、実行中、または失敗ステータスで返されます。
offset integer 省略可能 指定した時間範囲内の LogShipper タスクの開始数 (デフォルトは 0)。
size integer 省略可能 指定した時間範囲内の LogShipper タスクの数 (デフォルトは 100、 最大値は 500)。
リクエストヘッダー

GetShipperStatus API には特別なリクエストヘッダーはありません。Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。

レスポンスヘッダー

GetShipperStatus API に特別なレスポンスヘッダーはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、 「パブリックレスポンスヘッダー」をご参照ください。

レスポンス要素
リクエストが正常に実行されると、 レスポンスボディに指定された LogShipper タスクが含まれます。 
{
    "count" : 10,
    "total" : 20,
    "statistics" : {
        "running" : 0,
        "success" : 20,
        "fail" : 0 
    }
    "tasks" : [
        {
            "id" : "abcdefghijk",
            "taskStatus" : "success",
            "タスクメッセージ" : "" ,
            "taskCreateTime" : 1448925013,
            "taskLastDataReceiveTime" : 1448915013,
            "taskFinishTime" : 1448926013
        }
    ]
}
名前 データ型 説明
count integer 返されるタスクの数。
total integer 指定された範囲内のタスクの合計数。
statistics json 指定された範囲内のタスクステータスの統計。 詳細については、次の表をご参照ください。
tasks array 指定された範囲内の LogShipper タスクの詳細。 詳細については、次の表をご参照ください。
タスクステータスの統計
名前 データ型 説明
running integer 指定した範囲内の実行中のタスクの数。
success integer 指定された範囲内の成功したタスクの数。
fail integer 指定された範囲内で失敗したタスクの数。
タスクの詳細
名前 データ型 説明
id String LogShipper タスクの一意の ID。
taskStatus string LogShipper タスクのステータス (実行中、成功、失敗など)。
taskMessage string LogShipper タスクが失敗すると、エラー メッセージが表示されます。
taskCreateTime integer LogShipper タスクの作成時刻。
taskLastDataReceiveTime integer サーバーが LogShipper タスクの最後のログを受信した時刻 (ログ時刻ではなく、サーバー上の受信時刻)。
taskFinishTime integer LogShipper タスクの終了時刻。
エラーコード

Log Service API の一般的なエラー コード の他に、GetShipperStatus API から次の特別なエラー コードが返される場合があります。

HTTP ステータスコード エラーコード エラーメッセージ
404 ProjectNotExist プロジェクト {ProjectName} は存在しません。
404 LogStoreNotExist logstore {logstoreName} は存在しません。
400 ShipperNotExist shipper {logstoreName} は存在しません。
500 InternalServerError 内部サーバー エラー
400 ParameterInvalid 開始時刻は終了時刻より前でなければなりません
400 ParameterInvalid 過去 48 時間のタスクステータスのみサポートします
400 ParameterInvalid ステータスには成功/実行/失敗のみが含まれます
詳細な説明

LogShipper タスクのステータス照会は、過去 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 <yourAccessKeyId>:<yourSignature>, 
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
        }
    ]
}