# 列出运行中节点 - ListRunningNodes #### 功能介绍 列出运行中节点 #### 调用方法 请参见[如何调用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}/components/{component_id}/running-nodes 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。[获取项目ID](https://support.huaweicloud.com/api-secmaster/secmaster_03_0014.html) **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | workspace_id | 是 | String | **参数解释：** 工作空间ID **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | component_id | 是 | String | 组件ID | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | node_id | 否 | String | 节点ID | | node_name | 否 | String | 节点名称 | | limit | 否 | Long | 每页数量 | | offset | 否 | Integer | **参数解释：** 偏移量 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sort_key | 否 | String | 按照属性排序。 | | sort_dir | 否 | String | 排序顺序，支持 *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 | Long | 运行中节点数量 | | records | Array of [ComponentConfiguration] objects | 组件配置 | 表5ComponentConfiguration | 参数 | 参数类型 | 描述 | |:---|:---|:---| | component_id | String | 组件id. | | component_name | String | 组件名称 | | config_status | String | **参数解释**: 节点配置状态 - UN_SAVED 待保存 - SAVE_AND_UN_APPLY 待应用 - MOVE_AND_UN_APPLY 待移除 - APPLYING 应用中 - FAIL_APPLY 应用失败 - APPLIED 应用完成 **约束限制** 不涉及 **取值范围**: - UN_SAVED - SAVE_AND_UN_APPLY - MOVE_AND_UN_APPLY - APPLYING - FAIL_APPLY - APPLIED **默认值** 不涉及 | | create_time | Integer | 毫秒时间戳 | | fail_deploy_message | String | 部署失败的消息 | | ip_address | String | IP地址 | | list | Array of [ComponentConfigurationParam] objects | 组件配置参数列表 | | monitor | [Monitor] object | 监视器 | | node_apply_fail_enum | String | **参数解释**: 节点应用成功与否状态、原因 - COLLECTOR_USE 采集器使用中，无法移除 - NODE_OFFLINE 节点失联状态，无法应用 **约束限制** 不涉及 **取值范围**: - COLLECTOR_USE - NODE_OFFLINE **默认值** 不涉及 | | node_expansion | [IsapNodeExpansion] object | 节点扩展信息 | | node_id | String | 节点ID | | node_name | String | 节点名称 | | private_ip_address | String | IP地址 | | region | String | 地区 | | specification | String | 规范 | | vpc_endpoint_address | String | VPC端点地址 | | vpc_endpoint_id | String | VPC端点ID | 表6ComponentConfigurationParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | component_id | String | 组件id. | | configuration_id | String | 配置ID | | file_name | String | 文件名称 | | file_path | String | 文件路径 | | file_type | String | **参数解释**: 文件类型 - JVM JVM配置文件类型 - LOG4J2 Log4j2日志配置文件类型 - YML YAML配置文件类型 **约束限制** 不涉及 **取值范围**: - JVM - LOG4J2 - YML **默认值** 不涉及 | | node_id | String | 节点ID | | param | String | 参数 | | type | String | **参数解释**: 配置类型 - HISTORY 历史版本 - CURRENT_SAVE 当前保存 - CURRENT_APPLY 当前使用 **约束限制** 不涉及 **取值范围**: - HISTORY - CURRENT_SAVE - CURRENT_APPLY **默认值** 不涉及 | | version | Integer | 版本 | 表7Monitor | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | 磁盘写入速率 | 表8IsapNodeExpansion | 参数 | 参数类型 | 描述 | |:---|:---|:---| | custom_label | String | 自定义标签 | | data_center | String | 数据中心 | | description | String | 描述信息 | | maintainer | String | 维护人 | | network_plane | String | 网络平面 | | node_id | String | UUID | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 | | error_msg | String | 错误描述 | #### 请求示例 无 #### 响应示例 **状态码：200** 成功 ``` { "count" : 1, "records" : [ { "component_id" : "1603635xxx1444", "component_name" : "logstash", "config_status" : "APPLIED", "create_time" : 1768550588077, "ip_address" : "192.x.x.x", "monitor" : { "cpu_idle" : "5626052.0", "cpu_usage" : "2.5125628", "disk_count" : "140", "disk_usage" : "13", "down_pps" : "0.0", "health_status" : "LOST_CONTACT", "heart_beat" : "OFFLINE", "heart_beat_time" : 1769393085637, "memory_cache" : "1", "memory_count" : "4", "memory_free" : "1", "memory_shared" : "1", "memory_usage" : "2", "read_rate" : "0.0", "up_pps" : "0.0", "write_rate" : "0.0" }, "node_id" : "9c77d412xxx89d2", "node_name" : "ecs-5968-isap", "private_ip_address" : "192.x.x.x", "region" : "region_c", "specification" : "2U|4G|140G", "vpc_endpoint_address" : "192.x.x.x", "vpc_endpoint_id" : "f6ddf86cxxx3db2" } ] } ``` #### 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 ListRunningNodesSolution { 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(); ListRunningNodesRequest request = new ListRunningNodesRequest(); request.withWorkspaceId("{workspace_id}"); request.withComponentId("{component_id}"); try { ListRunningNodesResponse response = client.listRunningNodes(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 = ListRunningNodesRequest() request.workspace_id = "{workspace_id}" request.component_id = "{component_id}" response = client.list_running_nodes(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.ListRunningNodesRequest{} request.WorkspaceId = "{workspace_id}" request.ComponentId = "{component_id}" response, err := client.ListRunningNodes(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=ListRunningNodes&version=v1)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 成功 | | 400 | 错误响应 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-secmaster/ErrorCode.html)。