列出采集通道实例
功能介绍
列出采集通道实例
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/collector/channels/instances
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
workspace_id |
是 |
String |
工作空间ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
channel_id |
否 |
String |
Channel ID |
node_id |
否 |
String |
Node ID |
node_name |
否 |
String |
Node Name |
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 ChannelInstance objects |
相关描述信息 |
参数 |
参数类型 |
描述 |
---|---|---|
channel_name |
String |
分组名称 |
config_status |
String |
参数解释: 采集通道配置状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
create_by |
String |
Iam用户ID |
node_name |
String |
分组名称 |
region |
String |
地区 |
mini_on_online |
Boolean |
是否在线 |
public_ip_address |
String |
IP地址 |
private_ip_address |
String |
IP地址 |
monitor |
Monitor object |
监视器 |
read_write |
ReadWrite object |
读写记录 |
参数 |
参数类型 |
描述 |
---|---|---|
mini_on_online |
String |
是否在线 |
memory_count |
String |
物理内存条数量 |
memory_usage |
String |
已使用的物理内存量 |
memory_free |
String |
当前空闲的物理内存量 |
memory_shared |
String |
多个进程共享使用的内存总量 |
memory_cache |
String |
缓存数据的内存大小 |
cpu_usage |
String |
CPU 当前的使用率 |
cpu_idle |
String |
CPU 空闲时间的百分比 |
up_pps |
String |
上传数据包每秒数量 |
down_pps |
String |
下载数据包每秒数量 |
write_rate |
String |
磁盘写入速率 |
read_rate |
String |
磁盘读取速率 |
disk_count |
String |
系统中磁盘设备的数量 |
disk_usage |
String |
当前磁盘空间使用量 |
heart_beat_time |
String |
最后一次接收到心跳信号的时间,使用 ISO 8601 格式表示。 |
health_status |
String |
参数解释: 节点的健康状态
约束限制 不涉及 取值范围:
默认值 不涉及 |
heart_beat |
String |
参数解释: 节点是否成功收到心跳信号
约束限制 不涉及 取值范围:
默认值 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
参数解释: 节点是否成功收到心跳信号
约束限制 不涉及 取值范围:
默认值 不涉及 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
Success |
错误码
请参见错误码。