文档

GetShipperStatus - 获取日志投递任务状态

更新时间:
暂无替代API,请关注后续API最新发布。

查询日志投递任务状态。

接口说明

请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
log:GetShipperStatusRead
  • LogStore
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/shipper/{#ShipperName}
  • log:TLSVersion

请求语法

GET /logstores/{logstore}/shipper/{shipperName}/tasks

请求参数

名称类型必填描述示例值
projectstring

Project 名称。

ali-test-project
logstorestring

Logstore 名称。

ali-test-logstore
shipperNamestring

投递任务的名称。

test-shipper
fromlong

日志投递任务创建开始时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1409529600
tolong

日志投递任务创建结束时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1627269085
statusstring

默认为空,表示返回所有状态的任务,支持 success、fail 和 running 状态。

success
offsetinteger

查询开始行,默认值为 0。

0
sizeinteger

分页查询时,设置的每页行数。默认值为 100,最大值为 500。

100

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

响应内容类型。支持 application/json、application/x-protobuf 两种类型。

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长链接。取值包括:

  • close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。
  • keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。
close
Datestring

当前返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

服务端产生的标示,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5
object

返回结构体。

countlong

当前页返回的任务个数。

10
totallong

任务总数。

20
statisticsobject

任务汇总状态。

runninglong

状态为 running 的任务个数。

0
successlong

状态为 success 的任务个数。

20
faillong

状态为 fail 的任务个数。

0
tasksobject

投递任务详情。

idstring

投递任务 ID。

abcdefghijk
taskStatusstring

投递任务状态,为 running、success 和 fail 中的一种。

success
taskCodestring

任务错误码。

UnAuthorized
taskMessagestring

投递任务失败时的具体错误信息。

taskCreateTimelong

投递任务创建时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1448925013
taskLastDataReceiveTimelong

投递任务中的最近一条日志到达服务端时间(非日志时间,是服务端接收时间)。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1448915013
taskFinishTimelong

投递任务结束时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

1448926013
taskDataLinesinteger

投递任务已执行的条数。

0

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

HttpStatusCodeErrorCodeErrorMessage错误码描述
404ProjectNotExistProject ProjectName does not exist.Project 不存在。
404LogStoreNotExistLogstore logstoreName does not exist.Logstore 不存在。
400ShipperNotExistShipper shipperName does not exist.Shipper 不存在。
500InternalServerErrorInternal server error.内部服务调用错误。
400ParameterInvalidStart time must be earlier than end time.开始时间必须早于结束时间。
400ParameterInvalidOnly support query last 48 hours task status.只支持查询最近 48 小时的任务状态。
400ParameterInvalidStatus only contains success/running/fail.状态只包含 success、running 和 fail。

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

  • 本页导读
文档反馈