更新时间:2021-12-17 GMT+08:00
分享

创建网图任务

功能介绍

创建网图任务。

URI

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

    无。

请求

  • 请求样例
    https://ip:port/softcomai/datalake/collection/v1.0/netmap/task
    {
    "dataType": "performance",
    "collectorId": "Collector-82b0ce3d",
    "status": "save",
    "collectionMode": "AGENT",
    "protocolType": "sftp",
    "protocolCategory": "",
    "strategy": "interval",
    "interval": {
    "acquisitionUnit": "min",
    "acquisitionCycle": "30"
    },
    "protocolList": [
    {
    "host": "xx.xx.xx.xx",
    "port": "22",
    "userName": "root",
    "password": "Abc@123",
    "path": "/yy"
    }
    ]
    }
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    dataType

    String

    数据类型。

    dataType

    String

    数据类型。

    collectorId

    否(连接方式是AGENT时,必选)

    String

    采集机ID。

    status

    String

    操作状态。

    • save:保存任务。
    • start:开始采集。
    • stop:停止采集。

    collectionMode

    String

    连接方式,EIP AGENT VPN。

    protocolType

    String

    协议类型。

    protocolCategory

    String

    协议类别。

    strategy

    String

    采集策略。

    • once:一次性采集。
    • period:周期性采集。
    • interval:间隔性采集。

    interval.acquisitionUnit

    否(策略为间隔性必选)

    String

    间隔单位。

    • min:分钟。
    • hour:小时。

    interval.acquisitionCycle

    否(策略为间隔性必选)

    String

    间隔时长,取值范围为:1~10000。

    cron.jobType

    否(策略为周期性必选)

    Int

    cron作业类型,取值范围为:0~6。

    cron.second

    否(策略为周期性必选)

    Int

    秒,取值范围为:0~59。

    cron.minute

    否(策略为周期性必选)

    Int

    分钟,取值范围为:0~59。

    cron.hour

    否(策略为周期性必选)

    Int

    小时,取值范围为:0~23。

    protocolList.host

    String

    数据源IP。

    protocolList.port

    String

    数据源端口,取值范围为:1~65535。

    protocolList.userName

    String

    数据源名称。

    protocolList.password

    String

    数据源密码。

    protocolList.path

    String

    数据源路径。

响应

  • 响应样例
    {"success":true,"returnData":"4db94bdfca2842918d935a3d8d6caf35"}
  • 要素说明

    参数名

    参数类型

    备注

    success

    Boolean

    请求是否成功。

    returnData

    object

    返回值。

状态码

具体请参考状态码

相关文档