调用GetShipperStatus接口查询日志投递任务状态。

接口说明

投递任务状态查询时间区间只能指定为最近24小时之内。

请求语法

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

请求参数

  • 请求头

    GetShipperStatus接口无特有请求头。关于Log Service API的公共请求头,请参见公共请求头

  • 参数列表
    参数名称 类型 是否必须 示例值 描述
    logstoreName string test-logstore 日志库名称,同一Project中日志库名称为唯一值。
    shipperName string test-shipper 日志投递规则名称,同一Logstore 下日志投递规则名称为唯一值。
    from int 1448748198 日志投递任务创建开始时间。
    to int 1448948198 日志投递任务创建结束时间。
    status string success 默认为空,表示返回所有状态的任务,目前支持success/fail/running等状态。
    offset int 0 返回指定时间区间内投递任务的起始数目,默认值为0。
    size int 100 返回指定时间区间内投递任务的数目,默认值为100,最大为500。

返回数据

  • 响应头

    GetShipperStatus接口无特有响应头。关于Log Service API的公共响应头,请参见公共响应头

  • 响应元素
    HTTP状态码返回200则请求成功,其响应Body会包括指定的日志投递任务列表,具体如下:
    名称 类型 示例值 描述
    count int 10 返回的任务个数。
    total int 20 指定范围内任务总数。
    statistics json 指定范围内任务汇总状态,具体请参见下表。
    tasks array 指定范围内投递任务具体详情,具体请参见下表。
    statistics内容:
    名称 类型 示例值 描述
    running int 0 指定范围内状态为running的任务个数。
    success int 20 指定范围内状态为success的任务个数。
    fail int 0 指定范围内状态为fail的任务个数。
    tasks内容:
    名称 类型 示例值 描述
    id string abcdefghijk 具体投递任务的唯一任务ID。
    taskStatus string success 投递任务的具体状态,可能为running/success/fail中的一种。
    taskMessage string 投递任务失败时的具体错误信息。
    taskCreateTime int 1448925013 投递任务创建时间。
    taskLastDataReceiveTime int 1448915013 投递任务中的最近一条日志到达服务端时间(非日志时间,是服务端接收时间)。
    taskFinishTime int 1448926013 投递任务结束时间。

示例

  • 请求示例
    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
            }
        ]
    }

错误码

HTTP状态码 错误码 错误信息 描述
404 ProjectNotExist Project {ProjectName} does not exist. 项目不存在。
404 LogStoreNotExist logstore {logstoreName} does not exist. 日志库不存在。
400 ShipperNotExist shipper {logstoreName} does not exist. Shipper不存在。
500 InternalServerError internal server error. 内部服务调用错误。
400 ParameterInvalid start time must be earlier than end time. 开始时间必须早于结束时间。
400 ParameterInvalid only support query last 48 hours task status. 只支持查询最近48小时的任务状态。
400 ParameterInvalid status only contains success/running/fail. 状态只包含success/running/fail。

更多错误码,请参见通用错误码