cu-cockpit API接口使用手册：自动化运维的最佳实践

cu-cockpit API接口使用手册：自动化运维的最佳实践

【免费下载链接】cu-cockpitcu-cockpit is a lightweight, single-node deployed OS operation and maintenance management platform, focusing on providing an efficient visualized operation and maintenance solution for single-machine/single-node Linux environments.项目地址: https://gitcode.com/openeuler/cu-cockpit

前往项目官网免费下载：https://ar.openeuler.org/ar/

cu-cockpit是一款轻量级、单节点部署的操作系统运维管理平台，专注于为单机/单节点Linux环境提供高效的可视化运维解决方案。通过其丰富的API接口，用户可以轻松实现自动化运维任务，提升管理效率。

一、API接口概览

cu-cockpit提供了多个功能模块的API接口，涵盖系统监控、服务管理、配置管理等核心运维场景。主要API模块如下：

1.1 运行监控API

位于cu-cockpit-web/src/api/run/run.ts，提供系统运行状态监控相关接口：

• monitorStatus(mode: monitorMode)：获取系统监控状态
• hardInfo(mode: hardMode)：获取硬件信息
• memorySlot()：获取内存插槽信息
• pciInfo()：获取PCI设备信息

1.2 服务管理API

同样位于cu-cockpit-web/src/api/run/run.ts，用于服务管理：

• runServiceManage(data: ServiceManageType)：执行服务管理操作
• serviceStatus()：获取服务状态

1.3 配置管理API

位于cu-cockpit-web/src/api/config/config.ts，提供系统配置相关接口：

• configGet(mode: ModeType, key?: string)：获取配置信息
• timeSet(data: TimeType)：设置系统时间
• hostSet(data: hostType)：设置主机名
• configUpdate(data: string, file_path: string, dir_path: string)：更新配置文件

1.4 日志管理API

位于cu-cockpit-web/src/api/log/index.ts，用于日志查询：

• logs(params: logParams)：获取系统日志
• getBoot()：获取启动日志

1.5 终端连接API

位于cu-cockpit-web/src/api/terminal/index.ts，提供终端访问功能：

• connect(data: connectType)：连接终端
• check()：检查终端连接状态
• getToken()：获取终端连接令牌

二、API接口调用方法

2.1 请求配置

cu-cockpit的API请求通过cu-cockpit-web/src/utils/request.ts进行封装，默认配置如下：

• 基础URL：import.meta.env.VITE_API_URL
• 超时时间：50000ms
• 请求头：Content-Type: application/json
• 参数序列化：使用qs库，支持点语法

2.2 认证机制

目前API请求拦截器中注释了Token认证相关代码，如需启用，可取消cu-cockpit-web/src/utils/request.ts中第22-24行的注释：

// if (Session.get('token')) { // config.headers!['Authorization'] = `${Session.get('token')}`; // }

2.3 错误处理

API响应拦截器会对常见错误进行处理，包括：

• 网络超时：显示"网络超时"提示
• 网络连接错误：显示"网络连接错误"提示
• 401错误：清除缓存并跳转至登录页
• 500错误：显示"服务器内部错误"提示

三、核心API接口详解

3.1 系统监控接口

3.1.1 获取硬件信息

hardInfo(mode: hardMode): Promise<HardwareInfo>

参数说明：

• mode：硬件信息类型，具体取值需参考实际实现

返回值：

• 硬件信息对象，包含CPU、内存、磁盘等信息

3.1.2 获取内存插槽信息

memorySlot(): Promise<MemoryItem[]>

返回值：

• 内存插槽信息数组，每个元素包含插槽编号、容量、类型等信息

3.2 服务管理接口

3.2.1 执行服务管理操作

runServiceManage(data: ServiceManageType): Promise<ServiceResponse>

参数说明：

• data：服务管理参数，包含服务名称和操作类型（启动、停止、重启等）

返回值：

• 服务操作结果

3.3 配置管理接口

3.3.1 获取配置信息

configGet(mode: ModeType, key?: string): Promise<unknown>

参数说明：

• mode：配置类型，如'sshkey'、'time'、'gethostname'等
• key：可选，配置键名

返回值：

• 根据mode不同返回不同类型的配置数据

3.3.2 设置系统时间

timeSet(data: TimeType): Promise<TimeResponse>

参数说明：

• data：时间设置参数，包含日期和时间信息

返回值：

• 时间设置结果

四、API接口使用示例

4.1 获取系统监控状态

import { monitorStatus } from 'cu-cockpit-web/src/api/run/run.ts'; async function getSystemStatus() { try { const status = await monitorStatus('all'); console.log('系统监控状态:', status); // 处理监控数据 } catch (error) { console.error('获取监控状态失败:', error); } }

4.2 重启服务

import { runServiceManage } from 'cu-cockpit-web/src/api/run/run.ts'; async function restartService(serviceName: string) { try { const result = await runServiceManage({ service: serviceName, action: 'restart' }); console.log('服务重启结果:', result); } catch (error) { console.error('服务重启失败:', error); } }

五、API接口最佳实践

5.1 错误处理

建议在调用API时使用try/catch捕获异常，并根据错误类型进行相应处理：

try { // API调用 } catch (error) { if (error.response && error.response.status === 401) { // 处理未授权错误 } else if (error.message.includes('timeout')) { // 处理超时错误 } else { // 其他错误处理 } }

5.2 批量操作

对于需要批量执行的操作，建议使用Promise.all进行并行处理：

async function batchGetInfo() { try { const [memoryInfo, pciInfo] = await Promise.all([ memorySlot(), pciInfo() ]); console.log('内存信息:', memoryInfo); console.log('PCI信息:', pciInfo); } catch (error) { console.error('批量获取信息失败:', error); } }

5.3 接口调用频率控制

为避免对系统造成过大压力，建议对API调用进行频率控制：

// 使用防抖函数控制接口调用频率 import { debounce } from 'lodash'; const debouncedMonitorStatus = debounce(async (mode) => { return await monitorStatus(mode); }, 1000); // 1秒内最多调用一次

六、API接口扩展

如果现有API接口无法满足需求，可以通过以下方式进行扩展：

1. 在cu-cockpit-web/src/api目录下创建新的API模块文件
2. 使用service实例编写新的API请求函数
3. 在后端相应模块（如osmanager/config/views.py）添加对应的接口实现
4. 编写接口测试用例，位于tests/目录下

七、总结

cu-cockpit提供了丰富的API接口，为Linux系统的自动化运维提供了强大支持。通过合理使用这些接口，用户可以构建高效、可靠的自动化运维系统，提升运维效率，降低管理成本。

无论是系统监控、服务管理还是配置管理，cu-cockpit的API接口都提供了简单易用的调用方式，帮助用户轻松实现各种运维任务的自动化。

建议在使用API接口时，遵循最佳实践，做好错误处理和调用频率控制，以确保系统的稳定运行。

【免费下载链接】cu-cockpitcu-cockpit is a lightweight, single-node deployed OS operation and maintenance management platform, focusing on providing an efficient visualized operation and maintenance solution for single-machine/single-node Linux environments.项目地址: https://gitcode.com/openeuler/cu-cockpit