# 列出采集通道实例 - ListCollectorInstances #### 功能介绍 列出采集通道实例 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-secmaster/secmaster_03_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-secmaster/secmaster_03_0023.html)。 #### URI GET /v1/{project_id}/workspaces/{workspace_id}/collector/channels/instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | channel_id | 否 | String | 采集通道ID | | node_id | 否 | String | 节点ID | | node_name | 否 | String | 节点Name | | 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](https://support.huaweicloud.com/api-secmaster/secmaster_03_0010.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | count | Integer | 计数 | | records | Array of [ChannelInstance] objects | 相关描述信息 | 表5ChannelInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | channel_name | String | 分组名称 | | config_status | String | **参数解释**: 采集通道配置状态 - OK 完成 - CHANGE 修改 **约束限制** 不涉及 **取值范围**: - OK - CHANGE **默认值** 不涉及 | | create_by | String | Iam用户ID | | mini_on_online | Boolean | 是否在线 | | monitor | [Monitor] object | 监视器 | | node_name | String | 分组名称 | | private_ip_address | String | IP地址 | | public_ip_address | String | IP地址 | | read_write | [ReadWrite] object | 读写记录 | | region | String | 地区 | 表6Monitor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu_idle | String | CPU 空闲时间的百分比 | | cpu_usage | String | CPU 当前的使用率 | | disk_count | String | 系统中磁盘设备的数量 | | disk_usage | String | 当前磁盘空间使用量 | | down_pps | String | 下载数据包每秒数量 | | health_status | String | **参数解释**: 节点的健康状态 - NORMAL 正常 - ANOMALIES 异常 - FAULTS 故障 - LOST_CONTACT 失联 **约束限制** 不涉及 **取值范围**: - NORMAL - ANOMALIES - FAULTS - LOST_CONTACT **默认值** 不涉及 | | heart_beat | String | **参数解释**: 节点是否成功收到心跳信号 - ONLINE 在线 - OFFLINE 离线 **约束限制** 不涉及 **取值范围**: - ONLINE - OFFLINE **默认值** 不涉及 | | heart_beat_time | Long | 最后一次接收到心跳信号的时间 | | memory_cache | String | 缓存数据的内存大小 | | memory_count | String | 物理内存条数量 | | memory_free | String | 当前空闲的物理内存量 | | memory_shared | String | 多个进程共享使用的内存总量 | | memory_usage | String | 已使用的物理内存量 | | mini_on_online | String | 是否在线 | | read_rate | String | 磁盘读取速率 | | up_pps | String | 上传数据包每秒数量 | | write_rate | String | 磁盘写入速率 | 表7ReadWrite | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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/instances ``` #### 响应示例 **状态码：200** 成功 ``` { "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代码示例 SDK代码示例如下。 - [Java] ``` 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("")) .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()); } } } ``` - [Python] ``` # 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("")) \ .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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := secmaster.NewSecMasterClient(hcClient) request := &model.ListCollectorInstancesRequest{} request.WorkspaceId = "{workspace_id}" response, err := client.ListCollectorInstances(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SecMaster/sdk?api=ListCollectorInstances&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。