Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Querying the Collection Channel Instance List
Updated on 2026-02-05 GMT+08:00

Querying the Collection Channel Instance List

Function

This API is used to query the list of collection channel instances.

Calling Method

For details, see Calling APIs.

URI

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

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

channel_id

No

String

Collection channel ID.

node_id

No

String

Node ID.

node_name

No

String

Node name.

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 ChannelInstance objects

Description.

Table 5 ChannelInstance

Parameter

Type

Description

channel_name

String

Group name.

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.

mini_on_online

Boolean

Online or not.

monitor

Monitor object

Monitor.

node_name

String

Group name.

private_ip_address

String

IP address.

public_ip_address

String

IP address.

read_write

ReadWrite object

Read and write records.

region

String

Region.

Table 6 Monitor

Parameter

Type

Description

cpu_idle

String

Percentage of CPU idle time.

cpu_usage

String

Current CPU usage.

disk_count

String

Number of disk devices in the system.

disk_usage

String

Current disk space usage.

down_pps

String

Number of downloaded data packets per second.

health_status

String

Definition

Health status of nodes.

NORMAL: normal

  • ANOMALIES: abnormal

  • FAULTS: faulty

  • LOST_CONTACT: disconnected

Constraints

N/A

Range

  • NORMAL

  • ANOMALIES

  • FAULTS

  • LOST_CONTACT

Default Value

N/A

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

Long

Time when the last heartbeat signal was received.

memory_cache

String

Memory size of cached data.

memory_count

String

Number of physical memory modules.

memory_free

String

Current free physical memory.

memory_shared

String

Total memory shared by multiple processes.

memory_usage

String

Used physical memory.

mini_on_online

String

Online or not.

read_rate

String

Disk read rate.

up_pps

String

Number of uploaded data packets per second.

write_rate

String

Disk write rate.

Table 7 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.

Example Requests

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

Example Responses

Status code: 200

Successful.

{
  "count" : 1,
  "records" : [ {
    "channel_name" : "test02",
    "config_status" : "OK",
    "create_by" : "393d3606d69f48cf91741b14be9306d0",
    "monitor" : {
      "cpu_idle" : "1.1710842E+8",
      "cpu_usage" : "0.37406483",
      "disk_count" : "190",
      "disk_usage" : "9",
      "down_pps" : "0.0",
      "health_status" : "LOST_CONTACT",
      "heart_beat" : "OFFLINE",
      "heart_beat_time" : 1740557780000,
      "memory_cache" : "3",
      "memory_count" : "16",
      "memory_free" : "13",
      "memory_shared" : "1",
      "memory_usage" : "1",
      "read_rate" : "2.07",
      "up_pps" : "0.0",
      "write_rate" : "14.01"
    },
    "node_name" : "ecs-z60055177-caijitest",
    "private_ip_address" : "192.168.0.198",
    "public_ip_address" : "192.168.0.198",
    "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
    },
    "region" : "region_c"
  } ]
}

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

    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();
        ListCollectorInstancesRequest request = new ListCollectorInstancesRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListCollectorInstancesResponse response = client.listCollectorInstances(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 = ListCollectorInstancesRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_collector_instances(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.ListCollectorInstancesRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListCollectorInstances(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.