文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 租户采集/ 展示采集通道 - ShowCollectorChannel
更新时间:2026-01-29 GMT+08:00
分享

展示采集通道 - ShowCollectorChannel

功能介绍

展示采集通道

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

channel_id

String

采集通道ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

create_by

String

Iam用户ID

description

String

描述信息

error

String

参数解释:

采集通道失败类型

  • SUCCESS 成功

  • FILE_UPLOAD_ERROR 文件上传失败

  • FILE_COPY_ERROR 文件复制失败

  • FILE_ZIP_ERROR 文件压缩失败

  • SALT_EXECUTE_ERROR Salt执行出错

约束限制

不涉及

取值范围:

  • SUCCESS

  • FILE_UPLOAD_ERROR

  • FILE_COPY_ERROR

  • FILE_ZIP_ERROR

  • SALT_EXECUTE_ERROR

默认值

不涉及

group_id

String

UUID

input

Array of ShowModuleVo objects

相关描述信息

nodes

Array of NodeVo objects

相关描述信息

operation_status

String

参数解释:

采集通道部署的进度

  • READY 等待部署

  • START 开始部署

  • SUCCESS 部署成功

  • FAIL 部署失败

约束限制

不涉及

取值范围:

  • READY

  • START

  • SUCCESS

  • FAIL

默认值

不涉及

output

Array of ShowModuleVo objects

相关描述信息

parser_id

String

UUID

parser_name

String

所属租户名称

title

String

相关标题

表4 NodeVo

参数

参数类型

描述

args

Array of ArgsVo objects

相关描述信息

node_id

String

UUID

node_status

String

参数解释:

节点状态

  • RUN 运行

  • STOP 停止

约束限制

不涉及

取值范围:

  • RUN

  • STOP

默认值

不涉及

表5 ArgsVo

参数

参数类型

描述

key

String

value

String

表6 ShowModuleVo

参数

参数类型

描述

children

Array of CreateModuleVo objects

相关描述信息

connection_module_id

String

UUID

fields

Array of ModuleFieldVo objects

相关描述信息

name

String

名称

template_id

String

UUID

module_id

String

UUID

表7 CreateModuleVo

参数

参数类型

描述

children

Array of CreateModuleVo objects

相关描述信息

connection_module_id

String

UUID

fields

Array of ModuleFieldVo objects

相关描述信息

name

String

名称

template_id

String

UUID

表8 ModuleFieldVo

参数

参数类型

描述

connection_module_id

String

UUID

name

String

名称

other

String

其他信息

template_field_id

String

UUID

type

String

类型

value

String

请求示例

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

响应示例

状态码:200

成功

{
  "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代码示例

SDK代码示例如下。

 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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档