调用CLI命令获取指定时间段内目标Logstore下的投递任务状态。

请求语法

aliyunlog log get_shipper_tasks --project_name=<value> --logstore_name=<value> --shipper_name=<value> --start_time=<value> --end_time=<value> [--status_type=<value>] [--offset=<value>] [--size=<value>] [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>]

请求参数

该命令的必选和特有参数描述如下。
参数名称 数值类型 是否必选 示例值 描述
--project_name String aliyun-test-project Project名称。
--logstore_name String logstore-a Logstore名称。
--shipper_name String sls-doc-testshippername 投递任务名称。
--start_time Integer 1622607139 开始时间,Unix时间戳格式。
--end_time Integer 1622625139 结束时间,Unix时间戳格式。
--status_type String success 投递任务的状态。包括如下取值:
  • success:成功
  • fail:失败
--offset Integer 0 指定从某一行开始读取查询结果。默认值为0。
--size Integer 3 分页查询时,设置的每页行数。最大值为500。
关于该命令的全局参数,请参见 全局参数

示例

  • 请求示例
    获取指定时间段内目标Logstore下的投递任务状态。命令示例如下:
    aliyunlog log get_shipper_tasks --project_name="aliyun-test-project" --logstore_name="logstore-a" --shipper_name="sls-doc-testshippername" --start_time="1622607139" --end_time=1622625139 --status_type=true --offset=0 --size=3
  • 返回示例
    {
      "count": 3,
      "statistics": {
        "fail": 8,
        "running": 0,
        "success": 31
      },
      "tasks": [
        {
          "id": "d3342056eee7d7aaf4d1b451efca425f",
          "taskCode": "",
          "taskCreateTime": 1622618077,
          "taskDataLines": 2220,
          "taskFinishTime": 1622624458,
          "taskLastDataReceiveTime": 1622618077,
          "taskMessage": "",
          "taskStatus": "success"
        },
        {
          "id": "489c80695e119ef04e7db014492d3b17",
          "taskCode": "",
          "taskCreateTime": 1622618485,
          "taskDataLines": 1846,
          "taskFinishTime": 1622624893,
          "taskLastDataReceiveTime": 1622618485,
          "taskMessage": "",
          "taskStatus": "success"
        },
        {
          "id": "d15fe8224b5c97a8c6279e0bc90fefcb",
          "taskCode": "",
          "taskCreateTime": 1622618853,
          "taskDataLines": 2991,
          "taskFinishTime": 1622625254,
          "taskLastDataReceiveTime": 1622618853,
          "taskMessage": "",
          "taskStatus": "success"
        }
      ],
      "total": 39
    }

错误码

如果返回报错信息,请参见具体接口的错误码处理。更多信息,请参见GetShipperStatus错误码处理

API参考

GetShipperStatus