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

列出采集通道列表 - ListCollectorChannels

功能介绍

列出采集通道列表

调用方法

请参见如何调用API

授权信息

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

title

String

相关标题

connection_module_id

String

链接模块ID

parser_id

String

解析器ID

group_id

String

组ID

offset

Integer

第几页

limit

Integer

每页数量

sort_key

String

排序字段

sort_dir

String

参数解释:

目录排序

  • asc 升序排列

  • desc 降序排列

约束限制

不涉及

取值范围:

  • asc

  • desc

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

count

Integer

计数

records

Array of Channel objects

相关描述信息

表5 Channel

参数

参数类型

描述

action

String

参数解释:

节点运行状态的监控

  • START 开始

  • STOP 停止

  • REMOVE 移除

  • RESTART 重启

  • REFRESH 刷新

  • INSTALL 安装

约束限制

不涉及

取值范围:

  • START

  • STOP

  • REMOVE

  • RESTART

  • REFRESH

  • INSTALL

默认值

不涉及

channel_id

String

UUID

config_status

String

参数解释:

采集通道配置状态

  • OK 完成

  • CHANGE 修改

约束限制

不涉及

取值范围:

  • OK

  • CHANGE

默认值

不涉及

create_by

String

Iam用户ID

create_by_user

String

Iam用户名称

description

String

描述信息

error_type

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

默认值

不涉及

health_status

String

参数解释:

采集通道监控状态

  • SUCCESS_PART 部分运行

  • SUCCESS_ALL 全部运行

  • SUCCESS_NO 没有运行

约束限制

不涉及

取值范围:

  • SUCCESS_PART

  • SUCCESS_ALL

  • SUCCESS_NO

默认值

不涉及

input_id

String

UUID

input_name

String

所属租户名称

install_status

String

参数解释:

采集通道下发

  • READY 等待下发

  • ALL_SUCCESS 全部成功

  • PARTIAL_SUCCESS 部分成功

  • EXCEPTION 异常

约束限制

不涉及

取值范围:

  • READY

  • ALL_SUCCESS

  • PARTIAL_SUCCESS

  • EXCEPTION

默认值

不涉及

install_time

Integer

毫秒时间戳

node_refer_count

Long

关联的节点个数

operation_status

String

参数解释:

采集通道部署的进度

  • READY 等待部署

  • START 开始部署

  • SUCCESS 部署成功

  • FAIL 部署失败

约束限制

不涉及

取值范围:

  • READY

  • START

  • SUCCESS

  • FAIL

默认值

不涉及

output_id

String

UUID

output_name

String

所属租户名称

parser_id

String

UUID

parser_name

String

所属租户名称

read_write

ReadWrite object

读写记录

title

String

相关标题

update_time

Integer

毫秒时间戳

表6 ReadWrite

参数

参数类型

描述

accept_count

Long

数值

accept_rate

Long

数值

channel_id

String

UUID

channel_instance_count

Integer

采集通道实例的数量

heart_beat

String

参数解释:

节点是否成功收到心跳信号

  • ONLINE 在线

  • OFFLINE 离线

约束限制

不涉及

取值范围:

  • ONLINE

  • OFFLINE

默认值

不涉及

heart_beat_time

Integer

最后一次接收到心跳信号的时间

latest_transmission_time

String

最后一次传输的时间

minion_id

String

UUID

send_count

Long

数值

send_rate

Long

数值

请求示例

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

响应示例

状态码:200

成功

{
  "count" : 11,
  "records" : [ {
    "action" : "REMOVE",
    "channel_id" : "dc15b7fa-6dd0-4f12-8e35-4146d129a2c6",
    "config_status" : "OK",
    "create_by" : "w3_sec_ops_02:w3_ops:y*****54",
    "create_by_user" : "w3_sso_secmaster_ops_02",
    "description" : "",
    "error_type" : "SUCCESS",
    "health_status" : "SUCCESS_ALL",
    "input_id" : "ccec32f9-bcb1-4f9c-91c6-09a3cb73d036",
    "input_name" : "udp-test",
    "install_status" : "READY",
    "install_time" : 0,
    "node_refer_count" : 1,
    "operation_status" : "START",
    "output_id" : "4e1f7633-4444-461e-ac5a-51a78e2d8f5e",
    "output_name" : "tianjingle",
    "parser_id" : "a009aa99-3521-4ec0-8827-811e277515b1",
    "parser_name" : "quick",
    "read_write" : {
      "accept_count" : 0,
      "accept_rate" : 0,
      "channel_instance_count" : 0,
      "heart_beat" : "OFFLINE",
      "heart_beat_time" : 0,
      "send_count" : 0,
      "send_rate" : 0
    },
    "title" : "test02",
    "update_time" : 1761202170896
  } ]
}

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
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 ListCollectorChannelsSolution {

    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();
        ListCollectorChannelsRequest request = new ListCollectorChannelsRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListCollectorChannelsResponse response = client.listCollectorChannels(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
# 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 = ListCollectorChannelsRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_collector_channels(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
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.ListCollectorChannelsRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListCollectorChannels(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

成功

错误码

请参见错误码

相关文档