Querying the Collection Node List

This API is used to query the collection node list.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Value Range N/A Default value N/A
workspace_id	Yes	String	Workspace ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
health_status	No	String	Definition Health status of nodes. NORMAL: normal ANOMALIES: abnormal FAULTS: faulty LOST_CONTACT: disconnected Constraints N/A Range NORMAL ANOMALIES FAULTS LOST_CONTACT Default Value N/A
region	No	String	Region.
node_id	No	String	Node ID.
node_name	No	String	Node name.
ip_address	No	String	IP address.
offset	No	Long	Page number.
limit	No	Long	Number of records on each page.
limit	No	Long	Number of records on each page.
sort_key	No	String	Sorting field.
sort_dir	No	String	Definition Directory sorting. asc: ascending order desc: descending order Constraints N/A Range asc desc Default Value N/A

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Integer	Count.
records	Array of CollectorNode objects	Description.

**Table 5** CollectorNode
Parameter	Type	Description
channel_instance_refer_count	Integer	Numerical value.
create_by	String	IAM user ID.
custom_label	String	Custom tag.
description	String	Description.
device_type	String	Device type.
ip_address	String	IP address.
monitor	Monitor object	Monitor.
node_expansion	IsapNodeExpansion object	Node extension information.
node_id	String	UUID
node_name	String	Tenant name.
os_type	String	OS type.
private_ip_address	String	IP address.
project_id	String	Project ID.
region	String	Region.
specification	String	Specifications.
update_time	Integer	Millisecond timestamp.
vpc_endpoint_address	String	VPC endpoint address.
vpc_endpoint_id	String	VPC endpoint ID.
vpc_id	String	UUID
workspace_id	String	Workspace ID.

**Table 6** Monitor
Parameter	Type	Description
cpu_idle	String	Percentage of CPU idle time.
cpu_usage	String	Current CPU usage.
disk_count	String	Number of disk devices in the system.
disk_usage	String	Current disk space usage.
down_pps	String	Number of downloaded data packets per second.
health_status	String	Definition Health status of nodes. NORMAL: normal ANOMALIES: abnormal FAULTS: faulty LOST_CONTACT: disconnected Constraints N/A Range NORMAL ANOMALIES FAULTS LOST_CONTACT Default Value N/A
heart_beat	String	Definition Whether the node can successfully receive the heartbeat signal. ONLINE: It is online. OFFLINE: It is offline. Constraints N/A Range ONLINE OFFLINE Default Value N/A
heart_beat_time	Long	Time when the last heartbeat signal was received.
memory_cache	String	Memory size of cached data.
memory_count	String	Number of physical memory modules.
memory_free	String	Current free physical memory.
memory_shared	String	Total memory shared by multiple processes.
memory_usage	String	Used physical memory.
mini_on_online	String	Online or not.
read_rate	String	Disk read rate.
up_pps	String	Number of uploaded data packets per second.
write_rate	String	Disk write rate.