创建采集通道
功能介绍
创建采集通道
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/collector/channels
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
workspace_id |
是 |
String |
工作空间ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
参数解释: 节点运行状态的监控
约束限制 不涉及 取值范围:
默认值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
名称 |
template_id |
否 |
String |
UUID |
connection_module_id |
否 |
String |
UUID |
fields |
否 |
Array of ModuleFieldVo objects |
相关描述信息 |
children |
否 |
Array of CreateModuleVo objects |
相关描述信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
template_field_id |
否 |
String |
UUID |
name |
否 |
String |
名称 |
type |
否 |
String |
类型 |
value |
否 |
String |
值 |
other |
否 |
String |
其他信息 |
connection_module_id |
否 |
String |
UUID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
node_id |
否 |
String |
UUID |
args |
否 |
Array of ArgsVo objects |
相关描述信息 |
node_status |
否 |
String |
参数解释: 节点状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
success |
Boolean |
创建成功 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
Success |
错误码
请参见错误码。