全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
日志服务

GetShipperStatus

更新时间:2017-06-07 13:26:11

查询日志投递任务状态。

请求语法

  1. GET /logstores/{logstoreName}/shipper/{shipperName}/tasks?from=1448748198&to=1448948198&status=success&offset=0&size=100 HTTP/1.1
  2. Authorization: <AuthorizationString>
  3. Date: <GMT Date>
  4. Host: <Project Endpoint>
  5. x-log-apiversion: 0.6.0
  6. 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 会包括指定的日志投递任务列表:

  1. {
  2. "count" : 10,
  3. "total" : 20,
  4. "statistics" : {
  5. "running" : 0,
  6. "success" : 20,
  7. "fail" : 0
  8. }
  9. "tasks" : [
  10. {
  11. "id" : "abcdefghijk",
  12. "taskStatus" : "success",
  13. "taskMessage" : "",
  14. "taskCreateTime" : 1448925013,
  15. "taskLastDataReceiveTime" : 1448915013,
  16. "taskFinishTime" : 1448926013
  17. }
  18. ]
  19. }
名称 类型 描述
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 小时之内。

请求示例:
  1. GET /logstores/test-logstore/shipper/test-shipper/tasks?from=1448748198&to=1448948198&status=success&offset=0&size=100 HTTP/1.1
  2. Header:
  3. {
  4. x-log-apiversion=0.6.0,
  5. Authorization=LOG 94to3z418yupi6ikawqqd370:wFcl3ohVJupCi0ZFxRD0x4IA68A=,
  6. Host=ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com,
  7. Date=Wed, 11 Nov 2015 08:28:19 GMT,
  8. Content-Length=55,
  9. x-log-signaturemethod=hmac-sha1,
  10. Content-MD5=757C60FC41CC7D3F60B88E0D916D051E,
  11. User-Agent=sls-java-sdk-v-0.6.0,
  12. Content-Type=application/json
  13. }
响应示例:
  1. HTTP/1.1 200 OK
  2. Header:
  3. {
  4. Date=Wed, 11 Nov 2015 08:28:20 GMT,
  5. Content-Length=0,
  6. x-log-requestid=5642FC2399248C8F7B0145FD,
  7. Connection=close,
  8. Server=nginx/1.6.1
  9. }
  10. Body:
  11. {
  12. "count" : 10,
  13. "total" : 20,
  14. "statistics" : {
  15. "running" : 0,
  16. "success" : 20,
  17. "fail" : 0
  18. }
  19. "tasks" : [
  20. {
  21. "id" : "abcdefghijk",
  22. "taskStatus" : "success",
  23. "taskMessage" : "",
  24. "taskCreateTime" : 1448925013,
  25. "taskLastDataReceiveTime" : 1448915013,
  26. "taskFinishTime" : 1448926013
  27. }
  28. ]
  29. }
本文导读目录