Updated on 2026-02-05 GMT+08:00

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

https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/collector/channels/{channel_id}

Example Responses

Status code: 200

Successful.

{
  "create_by" : "0997a2e55700f3171ffdc014a8249457",
  "description" : "",
  "group_id" : "94e44a23-2673-4779-9517-f3b1ee451e7c",
  "input" : [ {
    "children" : [ ],
    "connection_module_id" : "8e70986f-9a4f-4aef-a693-ec50747a8bf4",
    "fields" : [ {
      "name" : "mode",
      "other" : "null",
      "template_field_id" : "926867ed-e31f-4766-911b-bad57f0c436a",
      "type" : "string",
      "value" : "server"
    }, {
      "name" : "port",
      "other" : "null",
      "template_field_id" : "a784d1d7-e049-4602-a7a8-c8cc1bff8c65",
      "type" : "number",
      "value" : "6666"
    }, {
      "name" : "codec",
      "other" : "null",
      "template_field_id" : "4d839ce2-485c-4a93-b778-fd02b6ad308e",
      "type" : "string",
      "value" : "json"
    }, {
      "name" : "type",
      "other" : "null",
      "template_field_id" : "774ce36f-6a46-4114-9d9f-6fba83590fd7",
      "type" : "string",
      "value" : "tcp"
    } ],
    "module_id" : "d50a6f78-53f3-4814-8e34-7cb80ecb98fe",
    "name" : "tcp",
    "template_id" : "d51164ad-40a4-4b26-9b9d-d454da34adec"
  } ],
  "nodes" : [ {
    "args" : [ {
      "key" : "#service_url",
      "value" : "192.168.0.49"
    } ],
    "node_id" : "95cf3f44fd144595b84c5957fde4d739",
    "node_status" : "RUN"
  } ],
  "operation_status" : "SUCCESS",
  "output" : [ {
    "children" : [ ],
    "connection_module_id" : "2dcaadc1-83a1-442f-bbd2-7e88d0b05c69",
    "fields" : [ {
      "name" : "type",
      "other" : "null",
      "template_field_id" : "8a767f76-9009-4197-8b34-341c81eaca44",
      "type" : "string",
      "value" : "tenant"
    }, {
      "name" : "pipeId",
      "other" : "fa4dad11-ed76-4fff-911d-7bedfe80ce03",
      "template_field_id" : "8a767f76-9009-4197-8b44-341c80eaca44",
      "type" : "string",
      "value" : "fa4dad11-ed76-4fff-911d-7bedfe80ce03"
    }, {
      "name" : "domain_name",
      "other" : "null",
      "template_field_id" : "2d5dfaed-c9d5-4e9b-b7a6-244001c3b3ee",
      "type" : "string",
      "value" : "hwstaff_p_SecCMCC"
    }, {
      "name" : "user_name",
      "other" : "null",
      "template_field_id" : "35c79e3b-595c-4328-927d-e181d9367393",
      "type" : "string",
      "value" : "deploy"
    }, {
      "name" : "user_password",
      "other" : "null",
      "template_field_id" : "35c79e3b-595c-4328-927d-e181d9367394",
      "type" : "string",
      "value" : ""
    } ],
    "module_id" : "a5dde5f3-da13-4f1c-9b5b-f05df89517ff",
    "name" : "pulsar",
    "template_id" : "c4618e27-5c9c-45fc-9a70-e5c5a7ce49d8"
  } ],
  "parser_id" : "a009aa99-3521-4ec0-8827-811e277515b1",
  "parser_name" : "quick",
  "title" : "honneypot-channel"
}

SDK Sample Code

The SDK sample code is as follows.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class ShowCollectorChannelSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowCollectorChannelRequest request = new ShowCollectorChannelRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withChannelId("{channel_id}");
        try {
            ShowCollectorChannelResponse response = client.showCollectorChannel(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowCollectorChannelRequest()
        request.workspace_id = "{workspace_id}"
        request.channel_id = "{channel_id}"
        response = client.show_collector_channel(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowCollectorChannelRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.ChannelId = "{channel_id}"
	response, err := client.ShowCollectorChannel(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.