Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Displaying Collection Channels
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Displaying Collection Channels

Function

This API is used to display collection channels.

Calling Method

For details, see Calling APIs.

URI

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

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.

channel_id

Yes

String

Collection channel ID.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

create_by

String

IAM user ID.

description

String

Description.

error

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

group_id

String

UUID

input

Array of ShowModuleVo objects

Description.

nodes

Array of NodeVo objects

Description.

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

Array of ShowModuleVo objects

Description.

parser_id

String

UUID

parser_name

String

Tenant name.

title

String

Related title.
Table 4 NodeVo

Parameter

Type

Description

args

Array of ArgsVo objects

Description.

node_id

String

UUID

node_status

String

Definition

Node status.

  • RUN: running

  • STOP: stopped

Constraints

N/A

Range

  • RUN

  • STOP

Default Value

N/A
Table 5 ArgsVo

Parameter

Type

Description

key

String

Key.

value

String

Value.
Table 6 ShowModuleVo

Parameter

Type

Description

children

Array of CreateModuleVo objects

Description.

connection_module_id

String

UUID

fields

Array of ModuleFieldVo objects

Description.

name

String

Name.

template_id

String

UUID

module_id

String

UUID
Table 7 CreateModuleVo

Parameter

Type

Description

children

Array of CreateModuleVo objects

Description.

connection_module_id

String

UUID

fields

Array of ModuleFieldVo objects

Description.

name

String

Name.

template_id

String

UUID
Table 8 ModuleFieldVo

Parameter

Type

Description

connection_module_id

String

UUID

name

String

Name.

other

String

Other information.

template_field_id

String

UUID

type

String

Type.

value

String

Value.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Tenant Collection