文档首页> 网络智能体> 数据资产管理服务> API参考> 数据接入> 管理采集任务> 创建采集任务(数据准备,含机机接口)
更新时间:2021-12-17 GMT+08:00
分享

创建采集任务(数据准备,含机机接口)

功能介绍

创建采集任务。

URI

  • URI格式
    POST /softcomai/datalake/collection/v1.0/task/create
  • 参数说明

    无。

请求

  • 请求样例
    • 请求租户下面的所有采集机上的所有探针创建探针实例,创建采集任务类型:appmarket。
      POST https://ip:port/softcomai/datalake/collection/v1.0/task/create
      {"taskName": "name","ossId":"oss","collectTaskType":"appmarket"}
    • 创建单个采集任务,创建任务类型:dataplan。
      POST https://ip:port/softcomai/datalake/collection/v1.0/task/create
      {
      "agreementType": "sftp",
      "collectTaskType": "dataplan",
      "taskId": "",
      "taskName": "12121",
      "collectorId": "Collector-883c0575",
      "probePackageName": "Probe_NAIE_SFTP_Common_V200R020C50SPC401.zip",
      "operate": "operate",
      "carrierSubnetsubNet": "",
      "country": "China",
      "domain": "IT",
      "netName": "U2000",
      "netWorkInfo": "121",
      "collectObjectType": "LIC",
      "securityLevel": "Secret",
      "authScope": "HWTP",
      "validPeriod": 1636041600000,
      "progressid": "P_20200522171603_520903745",
      "protocolBody": {
      "acquisitionCycle": "",
      "acquisitionUnit": "day",
      "delayTime": 0,
      "delayUnit": "min",
      "fileFilter": "",
      "host": "xx.xx.xx.xx",
      "port": "498",
      "userName": "fd",
      "password": "dkjjffd",
      "historyFrom": 1572537620000,
      "historyTo": 1604125927000,
      "ifInclude": "true",
      "isSupportCompress": "false",
      "extensionPathName1": "",
      "extensionPathName2": "",
      "extensionPathName3": "",
      "extensionPathName4": "",
      "extensionPathValue1": "",
      "extensionPathValue2": "",
      "extensionPathValue3": "",
      "extensionPathValue4": "",
      "path": "/tmp/test",
      "strategy": "period",
      "scanPeriod": "60"
      }
      }
    • 创建单个采集任务,创建任务类型:logService。
      POST https://ip:port/softcomai/datalake/collection/v1.0/task/create
      {"collectTaskType":"logService","progressid":"P_20200522171603_520903745"}
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    taskName

    String

    任务名称。

    collectTaskType

    String

    创建采集任务方式(appmarket/dataplan/ consoleServer/logService)。

    ossId

    String

    网管UUID。

    collectorId

    String

    采集机ID。

    progressId

    String

    流程ID。

    probePackageName

    String

    探针包名称。

    operate

    String

    运营商。

    country

    String

    国家。

    domain

    String

    领域。

    netName

    String

    网管名称。

    netWorkInfo

    String

    网元类型。

    collectObjectType

    String

    采集对象类型。

    securityLevel

    String

    密级。

    authScope

    String

    授权范围。

    agreementType

    String

    协议类型(SFTP/FTPS)。

    validPeriod

    Long

    数据有效期。

    protocolBody.scanPeriod

    String

    采集周期。

    protocolBody.host

    String

    主机IP。

    protocolBody.port

    String

    端口。

    protocolBody.userName

    String

    用户。

    protocolBody.password

    String

    密码。

    protocolBody.path

    String

    采集路径。

    protocolBody.strategy

    String

    采集策略。

    protocolBody.acquisitionUnit

    String

    采集单元。

    protocolBody.delayUnit

    String

    滞后时间单位。

    protocolConsoleBody.protocolList.extensionPathName1

    String

    扩展路径类型1(whiteList,fixedValue,timeType)。

    protocolBody.extensionPathValue1

    String

    扩展路径值。

    protocolBody.extensionPathName2

    String

    扩展路径类型1(whiteList,fixedValue,timeType)。

    protocolBody.extensionPathValue2

    String

    扩展路径值。

    protocolBody.extensionPathName3

    String

    扩展路径类型1(whiteList,fixedValue,timeType)。

    protocolBody.extensionPathValue3

    String

    扩展路径值。

    protocolBody.extensionPathName4

    String

    扩展路径4。

    protocolBody.extensionPathValue4

    String

    扩展路径值。

    protocolBody.isSupportInc

    String

    是否增量上报。

    protocolBody.isSupportFragment

    String

    是否支持分片。

    protocolBody.isSupportCompress

    String

    是否支持压缩。

    protocolBody.ifInclude

    String

    采集文件是否包含。

    protocolBody.sslMode

    String

    是否开启SSL认证。

    protocolBody.localHost

    String

    采集机小网IP。

    dataSourceId

    String

    数据源ID。

    protocolBody.fileFilter

    String

    文件名过滤条件。

响应

  • 响应样例
    {
    "success": true,
    "errorMsg": null,
    "errorCode": null,
    "returnData": "a2cab4690c41416eae798f8d90abe277"
    }
  • 要素说明

    参数名

    参数类型

    备注

    success

    boolean

    请求是否成功。

    errorMsg

    String

    错误描述。

    errorCode

    String

    错误码。

    returnData

    Object

    返回值。

状态码

具体请参考状态码

分享:

    相关文档

    相关产品

close