开发者社区> 问答> 正文

日志服务的GetShipperStatus有什么用处?





请求参数

参数名称类型是否必须描述
logstoreNamestring日志库名称,同一 project 下唯一
shipperNamestring日志投递规则名称,同一 logstore 下唯一
frominteger日志投递任务创建时间区间
tointeger日志投递任务创建时间区间
statusstring默认为空,表示返回所有状态的任务,目前支持 success/fail/running 等状态
offsetinteger返回指定时间区间内投递任务的起始数目,默认值为 0
sizeinteger返回指定时间区间内投递任务的数目,默认值为 100,最大为 500


请求头


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

响应头


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

响应元素


请求成功,其响应 Body 会包括指定的日志投递任务列表:

名称类型描述
countinteger返回的任务个数。
totalinteger指定范围内任务总数。
statisticsjson指定范围内任务汇总状态,具体请参考下表。
tasksarray指定范围内投递任务具体详情,具体请参考下表。

[backcolor=transparent]statistics 内容:
名称类型描述
runninginteger指定范围内状态为 running 的任务个数。
successinteger指定范围内状态为 success 的任务个数。
failinteger指定范围内状态为 fail 的任务个数。

[backcolor=transparent]tasks 内容:
名称类型描述
idstring具体投递任务的任务唯一 ID。
taskStatusstring投递任务的具体状态,可能为 running/success/fail 中的一种。
taskMessagestring投递任务失败时的具体错误信息。
taskCreateTimeinteger投递任务创建时间。
taskLastDataReceiveTimeinteger投递任务中的最近一条日志到达服务端时间(非日志时间,是服务端接收时间)。
taskFinishTimeinteger投递任务结束时间。


错误码


除了返回 Log Service API 的 通用错误码,还可能返回如下特有错误码:
HTTP 状态码ErrorCodeErrorMessage
404ProjectNotExistProject {ProjectName} not exist
404LogStoreNotExistlogstore {logstoreName} not exist
400ShipperNotExistshipper {logstoreName} not exist
500InternalServerErrorinternal server error
400ParameterInvalidstart time must litter than end time
400ParameterInvalidonly support query last 48 hours task status
400ParameterInvalidstatus only contains success/running/fail


细节描述


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

请求示例:





展开
收起
轩墨 2017-10-23 14:21:14 2129 0
0 条回答
写回答
取消 提交回答
问答标签:
问答地址:
问答排行榜
最热
最新

相关电子书

更多
PostgresChina2018_赖思超_PostgreSQL10_hash索引的WAL日志修改版final 立即下载
Kubernetes下日志实时采集、存储与计算实践 立即下载
日志数据采集与分析对接 立即下载