Querying the Collection Channel List

Function

This API is used to query the list of collection channels.

Calling Method

For details, see Calling APIs.

URI

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

**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
title	No	String	Related title.
connection_module_id	No	String	Associated module ID.
parser_id	No	String	Parser ID.
group_id	No	String	Group ID.
offset	No	Integer	Page number.
limit	No	Integer	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

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 Channel objects	Description.

**Table 5** Channel
Parameter	Type	Description
action	String	Definition Node running status monitoring. START: started STOP: stopped REMOVE: removed RESTART: restarted REFRESH: refreshed INSTALL: being installed Constraints N/A Range START STOP REMOVE RESTART REFRESH INSTALL Default Value N/A
channel_id	String	UUID
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.
create_by_user	String	IAM username.
description	String	Description.
error_type	String	Definition Collection channel failure type. SUCCESS: successful FILE_UPLOAD_ERROR: The file upload failed. FILE_COPY_ERROR: The file copy failed. FILE_ZIP_ERROR: The file compression failed. SALT_EXECUTE_ERROR: The Salt execution failed. Constraints N/A Range SUCCESS FILE_UPLOAD_ERROR FILE_COPY_ERROR FILE_ZIP_ERROR SALT_EXECUTE_ERROR Default Value N/A
health_status	String	Definition Monitoring status of the collection channel. SUCCESS_PART: partially running SUCCESS_ALL: all running SUCCESS_NO: not running Constraints N/A Range SUCCESS_PART SUCCESS_ALL SUCCESS_NO Default Value N/A
input_id	String	UUID
input_name	String	Tenant name.
install_status	String	Definition Collection channel delivery. READY: waiting for delivery ALL_SUCCESS: all successful PARTIAL_SUCCESS: partially successful EXCEPTION: exception Constraints N/A Range READY ALL_SUCCESS PARTIAL_SUCCESS EXCEPTION Default Value N/A
install_time	Integer	Millisecond timestamp.
node_refer_count	Long	Number of associated nodes.
operation_status	String	Definition Deployment progress of the collection channel. READY: pending deployment START: deployment started SUCCESS: deployment succeeded FAIL: deployment failed Constraints N/A Range READY START SUCCESS FAIL Default Value N/A
output_id	String	UUID
output_name	String	Tenant name.
parser_id	String	UUID
parser_name	String	Tenant name.
read_write	ReadWrite object	Read and write records.
title	String	Related title.
update_time	Integer	Millisecond timestamp.

**Table 6** ReadWrite
Parameter	Type	Description
accept_count	Long	Numerical value.
accept_rate	Long	Numerical value.
channel_id	String	UUID
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
heart_beat_time	Integer	Time when the last heartbeat signal was received.
latest_transmission_time	String	Last transmission time.
minion_id	String	UUID
send_count	Long	Numerical value.
send_rate	Long	Numerical value.