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

列出采集节点

功能介绍

列出采集节点

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及w

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

health_status

String

参数解释:

节点的健康状态

  • NORMAL 正常

  • ANOMALIES 异常

  • FAULTS 故障

  • LOST_CONTACT 失联

约束限制

不涉及

取值范围:

  • NORMAL

  • ANOMALIES

  • FAULTS

  • LOST_CONTACT

默认值

不涉及

region

String

地区

node_id

String

节点ID

node_name

String

节点名称

ip_address

String

IP地址

offset

Long

Offset

limit

Long

Limit

limit

Long

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 CollectorNode objects

相关描述信息

表5 CollectorNode

参数

参数类型

描述

update_time

Integer

毫秒时间戳

project_id

String

项目ID

workspace_id

String

工作空间ID

node_id

String

UUID

node_name

String

所属租户名称

region

String

区域

os_type

String

操作系统类型

specification

String

规格

ip_address

String

IP地址

private_ip_address

String

IP地址

description

String

描述信息

device_type

String

设备类型

create_by

String

Iam用户ID

vpc_id

String

UUID

channel_instance_refer_count

Integer

数值

custom_label

String

自定义标签

vpc_endpoint_address

String

Vpc 端点地址

vpc_endpoint_id

String

Vpc 端点ID

node_expansion

IsapNodeExpansion object

节点扩展信息

monitor

Monitor object

监视器

表6 IsapNodeExpansion

参数

参数类型

描述

node_id

String

UUID

data_center

String

数据中心

custom_label

String

自定义标签

network_plane

String

网络平面

description

String

描述信息

maintainer

String

维护人

表7 Monitor

参数

参数类型

描述

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

参数解释:

节点的健康状态

  • NORMAL 正常

  • ANOMALIES 异常

  • FAULTS 故障

  • LOST_CONTACT 失联

约束限制

不涉及

取值范围:

  • NORMAL

  • ANOMALIES

  • FAULTS

  • LOST_CONTACT

默认值

不涉及

heart_beat

String

参数解释:

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

  • ONLINE 在线

  • OFFLINE 离线

约束限制

不涉及

取值范围:

  • ONLINE

  • OFFLINE

默认值

不涉及

请求示例

响应示例

状态码

状态码

描述

200

Success

错误码

请参见错误码

相关文档