更新时间:2025-08-30 GMT+08:00
分享

创建采集通道

功能介绍

创建采集通道

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/workspaces/{workspace_id}/collector/channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

title

String

相关标题

description

String

描述信息

parser_id

String

UUID

group_id

String

UUID

input

Array of CreateModuleVo objects

相关描述信息

output

Array of CreateModuleVo objects

相关描述信息

nodes

Array of NodeVo objects

相关描述信息

action

String

参数解释:

节点运行状态的监控

  • START 开始

  • STOP 停止

  • REMOVE 移除

  • RESTART 重启

  • REFRESH 刷新

  • INSTALL 安装

约束限制

不涉及

取值范围:

  • START

  • STOP

  • REMOVE

  • RESTART

  • REFRESH

  • INSTALL

默认值

不涉及

表4 CreateModuleVo

参数

是否必选

参数类型

描述

name

String

名称

template_id

String

UUID

connection_module_id

String

UUID

fields

Array of ModuleFieldVo objects

相关描述信息

children

Array of CreateModuleVo objects

相关描述信息

表5 ModuleFieldVo

参数

是否必选

参数类型

描述

template_field_id

String

UUID

name

String

名称

type

String

类型

value

String

other

String

其他信息

connection_module_id

String

UUID

表6 NodeVo

参数

是否必选

参数类型

描述

node_id

String

UUID

args

Array of ArgsVo objects

相关描述信息

node_status

String

参数解释:

节点状态

  • RUN 运行

  • STOP 停止

约束限制

不涉及

取值范围:

  • RUN

  • STOP

默认值

不涉及

表7 ArgsVo

参数

是否必选

参数类型

描述

key

String

key

value

String

value

响应参数

状态码:200

表8 响应Body参数

参数

参数类型

描述

success

Boolean

创建成功

请求示例

响应示例

状态码

状态码

描述

200

Success

错误码

请参见错误码

相关文档