查询日志投递任务状态。
接口说明
请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
log:GetShipperStatus | Read |
|
| 无 |
请求语法
GET /logstores/{logstore}/shipper/{shipperName}/tasks
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
project | string | 是 | Project 名称。 | ali-test-project |
logstore | string | 是 | Logstore 名称。 | ali-test-logstore |
shipperName | string | 是 | 投递任务的名称。 | test-shipper |
from | long | 是 | 日志投递任务创建开始时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。 | 1409529600 |
to | long | 是 | 日志投递任务创建结束时间。Unix 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。 | 1627269085 |
status | string | 否 | 默认为空,表示返回所有状态的任务,支持 success、fail 和 running 状态。 | success |
offset | integer | 否 | 查询开始行,默认值为 0。 | 0 |
size | integer | 否 | 分页查询时,设置的每页行数。默认值为 100,最大值为 500。 | 100 |
返回参数
示例
正常返回示例
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
}
}
错误码
访问错误中心查看更多错误码。
HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
---|---|---|---|
404 | ProjectNotExist | Project ProjectName does not exist. | Project 不存在。 |
404 | LogStoreNotExist | Logstore logstoreName does not exist. | Logstore 不存在。 |
400 | ShipperNotExist | Shipper shipperName 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。 |
更多信息,请参见通用错误码。