查询采集任务列表

功能介绍

查询采集任务列表。

URI

• URI格式

  GET /softcomai/datalake/collection/v1.0/tasks

• 参数说明

  无。

请求

• 请求样例

  https://ip:port/softcomai/datalake/collection/v1.0/tasks?pageNum=1&pageSize=10&mainCategory=&status=&conditional=

• 参数说明

  参数名	是否必选	参数类型	备注
  taskId	否	String	任务ID。
  status	否	String	状态。
  mainCategory	否	String	主类。
  conditional	否	String	查询条件。
  pageNum	是	Int	当前页数。
  pageSize	是	Int	每页总条数。

响应

• 响应样例

  {
  	"success": true,
  	"returnData": {
  		"page": {
  			"currentPageNum": 1,
  			"lastPageNum": 4,
  			"totalPageNum": 4,
  			"startRowIndex": 0,
  			"gotoPageNum": 0,
  			"pageSize": 10,
  			"recordCount": 39
  		},
  		"dataList": [{
  			"taskId": "c5c95a4e6bfa45fa8df718c2c0f3ca79",
  			"taskName": "sftp_duan",
  			"userName": "xxxx",
  			"taskStatus": "init",
  			"lastStartTime": 0,
  			"strategy": "once",
  			"currentFilesCount": 0,
  			"currentFilesSize": 0,
  			"progress": 0,
  			"predictEndTime": 0,
  			"filesCount": 0,
  			"filesSize": 0,
  			"mainCategory": "pipe",
  			"subCategory": "cloudCore",
  			"protocolType": "sftp",
  			"protocolCategory": "",
  			"taskSource": "console"
  		}, {
  			"taskId": "d26d98c3b3c247a59b2e18c1c6ffa7f9",
  			"taskName": "cmc2",
  			"userName": "xxxx",
  			"taskStatus": "collecting",
  			"lastStartTime": 1616036657414,
  			"note": "",
  			"strategy": "interval",
  			"currentFilesCount": 0,
  			"currentFilesSize": 0,
  			"progress": 0,
  			"predictEndTime": 0,
  			"filesCount": 0,
  			"filesSize": 0,
  			"mainCategory": "cloud",
  			"subCategory": "cloudServiceData",
  			"protocolType": "rest",
  			"protocolCategory": "CMC",
  			"taskSource": "console"
  		}]
  	}
  }

• 要素说明

  参数名	参数类型	备注
  success	Boolean	请求是否成功。
  returnData	Object	返回值。
  page	Object	分页信息。具体参数说明请参见表1。

  表1 page参数说明

  参数名	参数类型	备注
  currentPageNum	Int	当前页数。
  lastPageNum	Int	最后一页页数。
  totalPageNum	Int	总页数。
  startRowIndex	Int	起始页数。
  gotoPageNum	Int	当前页数。
  pageSize	Int	每页总条数。
  recordCount	Int	总记录数。
  dataList	List	任务信息。具体参数说明请参见表2。

  表2 dataList参数说明

  参数名	参数类型	备注
  taskName	String	任务名称。
  taskId	String	任务ID。
  userName	String	用户名。
  taskStatus	String	任务状态。
  lastStartTime	String	最后一次启动时间。
  strategy	String	周期。
  currentFilesCount	String	当前采集文件总数。
  currentFilesSize	String	采集文件大小。
  progress	String	流程ID。
  predictEndTime	String	预计完成时间。
  filesCount	String	总的文件数。
  filesSize	String	总的采集文件大小。
  mainCategory	String	主类类型。
  subCategory	String	子类类型。
  protocolType	String	协议类型。
  protocolCategory	String	协议类别。
  taskSource	String	任务来源。

状态码

具体请参考状态码。