创建采集任务

功能介绍

创建采集任务。

URI

• URI格式

  POST /softcomai/datalake/collection/v1.0/task

• 参数说明

  无。

请求

• 请求样例

  POST https://ip:port/softcomai/datalake/collection/v1.0/task
  {
  "taskName": "sftp协议7",
  "collectTaskType": "consoleServer",
  "collectionMode": "AGENT",
  "collectorId": "Collector-f90e5e07",
  "protocolType": "sftp",
  "protocolCategory": "",
  "note": "我是个备注",
  "tag": "12333",
  "dataInfo": {
  "mainCategory": "pipe",
  "subCategory": "access",
  "device": "NCE-FAN",
  "dataType": "PM",
  "version": "common"
  },
  "strategy": "interval",
  "interval":{
  "acquisitionUnit":"min",
  "acquisitionCycle":"30"
  },
  "cron": {
  "jobType": 3,
  "second": 0,
  "minute": 15,
  "hour": 14
  },
  "protocolList": [
  {
  "host": "xx.xx.xx.xx",
  "port": "22",
  "userName": "root",
  "password": "Abc@123",
  "path": "/yy"
  },
  {
  "host": "xx.xx.xx.xx",
  "port": "22",
  "userName": "root",
  "password": "Abc@123",
  "path": "/opt/test"
  }
  ]
  }

• 参数说明

  参数名	是否必选	参数类型	备注
  taskName	是	String	任务名称。
  collectTaskType	是	String	创建采集任务方式（appmarket/dataplan/ consoleServer/logService/netMap）。
  tag	否	String	ossId（数据准备）。
  collectorId	否	String	采集ID。
  collectionMode	是	String	采集类型（EIP AGENT VPN）。
  protocolType	是	String	协议类型。
  protocolCategory	否	String	协议子类型。
  note	否	String	备注。
  dataType	否(collectTaskType=netMap必选)	String	数据类型。
  taskId	否	String	任务ID。
  strategy	是	String	采集周期。 once：一次性采集。 period：周期性采集。 interval：间隔性采集。
  serviceNames	否	String	服务名称。
  dataInfo	否	Object	数据信息对象。
  dataInfo.mainCategory	是	String	主类别。
  dataInfo.subCategory	是	String	子类别。
  dataInfo.device	是	String	网管、设备信息。
  dataInfo.dataType	是	String	数据类型。
  dataInfo.version	否	String	版本。
  interval	否（strategy=interval必选）	Object	间隔性策略。
  interval.acquisitionUnit	否	String	间隔单位。 min：分钟。 hour：小时。
  interval.acquisitionCycle	否	String	间隔时长。取值范围：1~10000。
  cron	否（strategy=period必选）	Object	周期性策略。
  cron.jobType	否	int	cron作业类型。取值范围：0~6。
  cron.second	否	int	秒。取值范围：0~59。
  cron.minute	否	int	分钟。取值范围：0~59。
  cron.hour	否	int	小时。取值范围：0~23。
  protocolList	是	List	协议列表。具体参数说明请参见表1。

  表1 protocolList参数说明

  参数名	是否必选	参数类型	备注
  protocolList.host	否	String	数据源IP。
  protocolList.port	否	String	数据源端口，取值范围为：1~65535。
  protocolList.userName	否	String	数据源名称。
  protocolList.password	否	String	数据源密码。
  protocolList.path	否	String	数据源路径。
  protocolList.database	否	String	数据库名（数据源为Database使用）。
  protocolList.tables	否	String	表名（数据源为Database使用）。
  protocolList.protocolVersion	否	String	数据库版本（数据源为Database使用）。
  protocolList.dataTable	否	String	硬盘数据表（数据源为硬盘使用）。
  protocolList.dataId	否	String	硬盘数据ID（数据源为硬盘使用）。
  protocolList.localhost	否	String	采集机IP（数据源为Corba使用）。
  protocolList.sslMode	否	String	SSL认证（数据源为Corba使用）。
  protocolList.kafkaId	否	String	kafkaId（数据源为Kafka使用）。
  protocolList.brokers	否	String	kafka集群地址（数据源为Kafka使用）。
  protocolList.principal	否	String	kerberos用户（数据源为Kafka使用）。
  protocolList.truststorePassword	否	String	truststore证书密码（数据源为Kafka使用）。
  protocolList.keystorePassword	否	String	keystore证书密码（数据源为Kafka使用）。
  protocolList.sslMode	否	String	SSL认证（数据源为Corba使用）。

响应

• 响应样例

  {"success":true,"returnData":"fcbca5cf75394b0295ef099d062d36a3"}

• 要素说明

  参数名	参数类型	备注
  success	boolean	请求是否成功。
  returnData	Object	返回值。

状态码

具体请参考状态码。