列出采集通道列表 - ListCollectorChannels
功能介绍
列出采集通道列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/collector/channels
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数解释: 目录排序
约束限制 不涉及 取值范围:
默认值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
计数 |
|
records |
Array of Channel objects |
相关描述信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
channel_id |
String |
UUID |
|
create_by |
String |
Iam用户ID |
|
create_by_user |
String |
Iam用户名称 |
|
title |
String |
相关标题 |
|
description |
String |
描述信息 |
|
config_status |
String |
参数解释: 采集通道配置状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
health_status |
String |
参数解释: 采集通道监控状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
install_status |
String |
参数解释: 采集通道下发
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
operation_status |
String |
参数解释: 采集通道部署的进度
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
error_type |
String |
参数解释: 采集通道失败类型
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
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 |
参数解释: 节点运行状态的监控
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
read_write |
ReadWrite object |
读写记录 |
|
update_time |
Integer |
毫秒时间戳 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
channel_id |
String |
UUID |
|
minion_id |
String |
UUID |
|
accept_count |
Long |
数值 |
|
send_count |
Long |
数值 |
|
accept_rate |
Long |
数值 |
|
send_rate |
Long |
数值 |
|
heart_beat_time |
Integer |
最后一次接收到心跳信号的时间 |
|
latest_transmission_time |
String |
最后一次传输的时间 |
|
channel_instance_count |
Integer |
采集通道实例的数量 |
|
heart_beat |
String |
参数解释: 节点是否成功收到心跳信号
约束限制 不涉及 取值范围:
默认值 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success |
错误码
请参见错误码。