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

列出采集通道列表

功能介绍

列出采集通道列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

title

String

相关标题

connection_module_id

String

链接模块ID

parser_id

String

解析器ID

group_id

String

组ID

offset

Integer

Offset

limit

Integer

Limit

sort_key

String

Sort Key

sort_dir

String

参数解释:

目录排序

  • asc 升序排列

  • desc 降序排列

约束限制

不涉及

取值范围:

  • asc

  • desc

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of Channel objects

相关描述信息

表5 Channel

参数

参数类型

描述

channel_id

String

UUID

create_by

String

Iam用户ID

create_by_user

String

Iam用户名称

title

String

相关标题

description

String

描述信息

config_status

String

参数解释:

采集通道配置状态

  • OK 完成

  • CHANGE 修改

约束限制

不涉及

取值范围:

  • OK

  • CHANGE

默认值

不涉及

health_status

String

参数解释:

采集通道监控状态

  • SUCCESS_PART 部分运行

  • SUCCESS_ALL 全部运行

  • SUCCESS_NO 没有运行

约束限制

不涉及

取值范围:

  • SUCCESS_PART

  • SUCCESS_ALL

  • SUCCESS_NO

默认值

不涉及

install_status

String

参数解释:

采集通道下发

  • READY 等待下发

  • ALL_SUCCESS 全部成功

  • PARTIAL_SUCCESS 部分成功

  • EXCEPTION 异常

约束限制

不涉及

取值范围:

  • READY

  • ALL_SUCCESS

  • PARTIAL_SUCCESS

  • EXCEPTION

默认值

不涉及

operation_status

String

参数解释:

采集通道部署的进度

  • READY 等待部署

  • START 开始部署

  • SUCCESS 部署成功

  • FAIL 部署失败

约束限制

不涉及

取值范围:

  • READY

  • START

  • SUCCESS

  • FAIL

默认值

不涉及

error_type

String

参数解释:

采集通道失败类型

  • SUCCESS 成功

  • FILE_UPLOAD_ERROR 文件上传失败

  • FILE_COPY_ERROR 文件复制失败

  • FILE_ZIP_ERROR 文件压缩失败

  • SALT_EXECUTE_ERROR Salt执行出错

约束限制

不涉及

取值范围:

  • SUCCESS

  • FILE_UPLOAD_ERROR

  • FILE_COPY_ERROR

  • FILE_ZIP_ERROR

  • SALT_EXECUTE_ERROR

默认值

不涉及

install_time

Integer

毫秒时间戳

parser_id

String

UUID

parser_name

String

所属租户名称

input_id

String

UUID

input_name

String

所属租户名称

output_id

String

UUID

output_name

String

所属租户名称

node_refer_count

Long

关联的节点个数

action

String

参数解释:

节点运行状态的监控

  • START 开始

  • STOP 停止

  • REMOVE 移除

  • RESTART 重启

  • REFRESH 刷新

  • INSTALL 安装

约束限制

不涉及

取值范围:

  • START

  • STOP

  • REMOVE

  • RESTART

  • REFRESH

  • INSTALL

默认值

不涉及

read_write

ReadWrite object

读写记录

update_time

Integer

毫秒时间戳

表6 ReadWrite

参数

参数类型

描述

channel_id

String

UUID

minion_id

String

UUID

accept_count

Long

数值

send_count

Long

数值

accept_rate

Long

数值

send_rate

Long

数值

heart_beat_time

String

最后一次接收到心跳信号的时间

latest_transmission_time

String

最后一次传输的时间

channel_instance_count

Integer

采集通道实例的数量

heart_beat

String

参数解释:

节点是否成功收到心跳信号

  • ONLINE 在线

  • OFFLINE 离线

约束限制

不涉及

取值范围:

  • ONLINE

  • OFFLINE

默认值

不涉及

请求示例

响应示例

状态码

状态码

描述

200

Success

错误码

请参见错误码

相关文档