请求参数
参数名称 | 类型 | 是否必须 | 描述 |
logstoreName | string | 是 | 日志库名称,同一 project 下唯一 |
shipperName | string | 是 | 日志投递规则名称,同一 logstore 下唯一 |
from | integer | 是 | 日志投递任务创建时间区间 |
to | integer | 是 | 日志投递任务创建时间区间 |
status | string | 否 | 默认为空,表示返回所有状态的任务,目前支持 success/fail/running 等状态 |
offset | integer | 否 | 返回指定时间区间内投递任务的起始数目,默认值为 0 |
size | integer | 否 | 返回指定时间区间内投递任务的数目,默认值为 100,最大为 500 |
名称 | 类型 | 描述 |
count | integer | 返回的任务个数。 |
total | integer | 指定范围内任务总数。 |
statistics | json | 指定范围内任务汇总状态,具体请参考下表。 |
tasks | array | 指定范围内投递任务具体详情,具体请参考下表。 |
名称 | 类型 | 描述 |
running | integer | 指定范围内状态为 running 的任务个数。 |
success | integer | 指定范围内状态为 success 的任务个数。 |
fail | integer | 指定范围内状态为 fail 的任务个数。 |
名称 | 类型 | 描述 |
id | string | 具体投递任务的任务唯一 ID。 |
taskStatus | string | 投递任务的具体状态,可能为 running/success/fail 中的一种。 |
taskMessage | string | 投递任务失败时的具体错误信息。 |
taskCreateTime | integer | 投递任务创建时间。 |
taskLastDataReceiveTime | integer | 投递任务中的最近一条日志到达服务端时间(非日志时间,是服务端接收时间)。 |
taskFinishTime | integer | 投递任务结束时间。 |
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 |
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
根据您提供的信息,这是关于阿里云日志服务(Log Service)中查询日志投递任务状态(GetShipperStatus)接口的详细说明。此接口允许用户获取指定日志库(logstore)中日志投递规则(shipper)的任务状态信息。下面是对使用该接口的关键点和示例的总结:
string
, 必须): 日志库的名称,在同一项目(project)下必须唯一。string
, 必须): 日志投递规则的名称,在同一日志库下唯一。integer
, 必须): 查询日志投递任务创建时间区间的起始时间(Unix时间戳,单位为秒)。integer
, 必须): 查询日志投递任务创建时间区间的结束时间(Unix时间戳,单位为秒)。string
, 可选): 过滤任务状态,默认为空表示返回所有状态的任务,支持的状态包括 success
、fail
、running
等。integer
, 可选): 返回结果的起始偏移量,默认值为0。integer
, 可选): 单次请求返回的结果数量,默认值为10,最大为500。响应会包含任务的总数、统计信息(按状态分类的任务数),以及具体任务的详情列表,包括每个任务的ID、状态、错误信息、创建时间、最后接收数据时间和完成时间等。
虽然您提到请求示例,但未直接提供,一个典型的HTTP GET请求示例(使用cURL命令)可能如下所示,假设已替换为实际的值:
curl -X GET \
'https://log-cn-hangzhou.aliyuncs.com/logstores/your_logstore_name/shippers/your_shipper_name/status?from=1629900000&to=1629986399' \
-H 'Authorization: YOUR_ACCESS_KEY_ID:YOUR_SIGNATURE' \
-H 'x-log-bodyrawsize: 0' \
-H 'Content-Type: application/json'
请确保替换your_logstore_name
、your_shipper_name
、YOUR_ACCESS_KEY_ID
、YOUR_SIGNATURE
以及时间戳from
和to
为实际的值,并根据需要调整其他可选参数。此外,签名生成需遵循阿里云API调用规范,通常涉及AccessKey、Signature等安全认证信息的处理。
以上内容基于您提供的接口描述,希望对您使用阿里云日志服务中的GetShipperStatus接口有所帮助。