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

更新采集任务(数据节点)

功能介绍

更新采集任务。

URI

  • URI格式
    PUT /softcomai/datalake/collection/v1.0/task/{taskId}
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    taskId

    String

    任务ID。

请求

  • 请求样例
    https://ip:port/softcomai/datalake/collection/v1.0/task/c5c95a4e6bfa45fa8df718c2c0f3ca79
    {
    "taskName": "sftp_duan",
    "collectTaskType": "consoleServer",
    "collectionMode": "AGENT",
    "protocolType": "sftp",
    "protocolCategory": "",
    "tag": "123",
    "dataInfo": {
    "mainCategory": "pipe",
    "subCategory": "cloudCore",
    "device": "MAE-CN",
    "dataType": "performanceData",
    "version": ""
    },
    "strategy": "once",
    "protocolList": [{
    "agreementType": {
    "id": "SFTP",
    "label": "SFTP"
    },
    "authenticationPwd": "",
    "dataSourceName": "数据源1",
    "database": "",
    "tables": "",
    "protocolCategory": "",
    "protocolVersion": "",
    "encryptionPwd": "",
    "hardDiskDataId": "",
    "hardDiskDataTable": "",
    "host": "xx.xx.xx.xx",
    "id": 1,
    "isConnectSuccess": true,
    "password": "Changeme_123",
    "path": "/opt/test",
    "port": "22",
    "sslMode": "false",
    "userName": "root",
    "serviceNames": "",
    "kafkaCertification": null,
    "kafkaTopic": null,
    "kafkaOptions": [],
    "topicsJsonStr": "[null]"
    }]
    }
  • 参数说明

    参数名

    是否必选

    参数类型

    说明

    taskName

    String

    任务名称。

    collectTaskType

    String

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

    tag

    String

    ossId (数据准备)。

    collectionMode

    String

    采集Agent类型。

    protocolType

    String

    协议类型。

    protocolCategory

    String

    协议子类型。

    strategy

    String

    采集周期。

    serviceNames

    String

    服务名称(CMC采集使用)。

    topicsJsonStr

    String

    tpoic(Kafka采集)。

    brokers

    String

    Kafka集群地址。

    groupId

    String

    数据源关联ID。

    userName

    String

    用户名。

    password

    String

    密码。

    dataInfo

    object

    数据信息。

    mainCategory

    String

    主类别。

    subCategory

    String

    子类别。

    device

    String

    网管、设备信息。

    dataType

    String

    数据类型。

    version

    String

    版本。

    protocolList

    List

    数据源信息列表。

    id

    String

    协议ID。

    dataSourceName

    String

    数据源名称。

    agreementType

    Object

    协议类型。

    label

    String

    协议标签。

    id

    String

    协议ID。

    host

    String

    IP地址。

    port

    String

    端口号。

    path

    String

    采集路径。

    databaseType

    String

    数据库采集使用数据类型。

    databaseVersion

    String

    数据库采集使用数据库版本。

    kafkaTopic

    String

    kafka topic(需要采集的主题)。

    localHost

    String

    本地主机。

    netMapCountry

    String

    国家信息。

    netMapProvince

    String

    省份信息。

    netMapCity

    String

    城市信息。

    constructionCategory

    String

    施工类别。

    constructionType

    String

    施工类型。

    databaseName

    String

    数据库实例名。

    databaseTableName

    String

    数据库表名。

    hardDiskDataTable

    String

    硬盘数据采集表名。

    hardDiskDataId

    String

    硬盘数据采集数据ID。

    isConnectSuccess

    String

    是否连通性测试成功。

    topicList

    list

    topic列表。

    sslMode

    String

    是否SSL类型。

    protocolCategory

    String

    协议子类。

    protocolVersion

    String

    协议版本。

    database

    String

    数据库实例名。

    tables

    String

    表名。

    snmpFormData

    object

    SNMP。

    collectionMode

    String

    链接方式。

    protocolType

    String

    协议类型。

    protocolCategory

    String

    协议子类。

    protocolList

    list

    网管信息列表。

    host

    String

    网管IP地址。

    port

    String

    网管端口号。

    userName

    String

    网管用户名。

    password

    String

    网管密码。

    path

    String

    网管路径。

    sslMode

    String

    是否加密模式。

    localHost

    String

    本地IP。

    protocolVersion

    String

    协议版本。

    database

    String

    数据库实例名。

    tables

    String

    表名。

    dataTable

    String

    数据库表。

    dataId

    String

    数据ID。

响应

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

    参数名

    参数类型

    备注

    success

    Boolean

    请求是否成功。

    returnData

    Object

    返回值。

状态码

具体请参考状态码

分享:

    相关文档

    相关产品

close