Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Tenant Collection/ Querying the Collection Channel Instance List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Collection Channel Instance List

Function

This API is used to query the list of collection channel instances.

Calling Method

For details, see Calling APIs.

URI

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

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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

channel_id

No

String

Channel ID

node_id

No

String

Node ID

node_name

No

String

Node Name

offset

No

Integer

Offset

limit

No

Integer

Limit

sort_key

No

String

Sort Key

sort_dir

No

String

Definition

Directory sorting.

  • asc: ascending order

  • desc: descending order

Constraints

N/A

Range

  • asc

  • desc

Default Value

N/A

Request Parameters

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Count.

records

Array of ChannelInstance objects

Description.
Table 5 ChannelInstance

Parameter

Type

Description

channel_name

String

Group name.

config_status

String

Definition

Configuration status of the collection channel.

  • OK: Completed

  • CHANGE: changed

Constraints

N/A

Range

  • OK

  • CHANGE

Default Value

N/A

create_by

String

IAM user ID.

node_name

String

Group name.

region

String

Region.

mini_on_online

Boolean

Online or not.

public_ip_address

String

IP address.

private_ip_address

String

IP address.

monitor

Monitor object

Monitor.

read_write

ReadWrite object

Read and write records.
Table 6 Monitor

Parameter

Type

Description

mini_on_online

String

Online or not.

memory_count

String

Number of physical memory modules.

memory_usage

String

Used physical memory.

memory_free

String

Current free physical memory.

memory_shared

String

Total memory shared by multiple processes.

memory_cache

String

Memory size of cached data.

cpu_usage

String

Current CPU usage.

cpu_idle

String

Percentage of CPU idle time.

up_pps

String

Number of uploaded data packets per second.

down_pps

String

Number of downloaded data packets per second.

write_rate

String

Disk write rate.

read_rate

String

Disk read rate.

disk_count

String

Number of disk devices in the system.

disk_usage

String

Current disk space usage.

heart_beat_time

Long

Time when the last heartbeat signal was received.

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
Table 7 ReadWrite

Parameter

Type

Description

channel_id

String

UUID

minion_id

String

UUID

accept_count

Long

Numerical value.

send_count

Long

Numerical value.

accept_rate

Long

Numerical value.

send_rate

Long

Numerical value.

heart_beat_time

Integer

Time when the last heartbeat signal was received.

latest_transmission_time

String

Last transmission time.

channel_instance_count

Integer

Number of collection channel instances.

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

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection