更新采集任务(数据节点)
功能介绍
更新采集任务。
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
返回值。
状态码
具体请参考状态码。