命令执行系统

index.js - HTTP API文档

生成时间: 2026-01-30T12:21:52.167Z 源文件: index.js API端点数量: 20

HTTP API 文档

概述

该系统提供系统命令管理和Web3相关功能的API接口，基于Express.js框架实现。

路由分组

所有API路由均以 /systemcmd 或 /system 为前缀，分为系统命令执行、Web3功能和系统管理三类。

API端点表格

系统命令执行

HTTP方法 路由路径 描述 请求参数 响应格式 状态码
ALL /systemcmd/run 异步执行系统命令（实时流式输出） cmd: 命令字符串
xid: 会话ID
cwd: 工作目录
user_id: 用户ID
ostype: 操作系统类型		 {ret: boolean, msg: string} 200
ALL /systemcmd/run-sync 同步执行系统命令（一次性返回结果） cmd: 命令字符串
cwd: 工作目录
ostype: 操作系统类型
timeout: 超时时间（毫秒，默认300000）		 {ret: boolean, msg: string, data: {output: string, error: string, exitCode: number, success: boolean}} 200
ALL /systemcmd/post 向正在执行的命令进程发送输入或终止命令 cmd: 输入命令
kill: 是否终止进程
xid: 会话ID		 {ret: boolean, msg: string} 200
ALL /systemcmd/pty 使用PTY终端执行命令 cmd: 命令
cwd: 工作目录
kill: 是否终止
xid: 会话ID
cols: 终端列数
rows: 终端行数
user_id: 用户ID		 {ret: boolean, msg: string, new_flag: boolean, killed: boolean} 200

Web3功能

HTTP方法 路由路径 描述 请求参数 响应格式 状态码
ALL /systemcmd/dtns/static 查询DTNS所有Web3应用和网络信息 无 {ret: boolean, msg: string, list: Array, networks: Object} 200
ALL /systemcmd/web3/cid 生成Web3应用访问ID num: 生成数量（默认1） {ret: boolean, msg: string, list: Array<string>} 200

系统管理

HTTP方法 路由路径 描述 请求参数 响应格式 状态码
ALL /systemcmd/killapp 终止应用程序进程 无 {ret: boolean, msg: string} 200
ALL /system/apps/default 获取系统默认应用配置 无 {ret: boolean, msg: string, setting: Object} 200

中间件使用情况

  1. urlParser: 所有路由都使用，用于解析URL参数
  2. console_filter: 部分路由使用，用于控制台过滤
  3. session_filter: 命令执行相关路由使用，用于会话过滤
  4. systemcmd_allows_filter: 命令执行相关路由使用，用于权限验证（检查用户是否在允许列表中）

业务数据存储格式说明

Web3 CID存储格式

{
  "web3-cid:[cid]": {
    "value": "new",
    "expire": 31536000  // 1年有效期（秒）
  }
}

DTNS静态数据格式

{
  "list": [
    // Web3应用列表
  ],
  "networks": {
    // 网络信息映射对象
  }
}

系统默认应用配置

{
  // 从 systemcmd-apps-default.json 文件读取的配置
}

命令执行结果格式（WebSocket推送）

{
  "channel": "rtterm",
  "notify_type": "[xid]",
  "data": "命令输出内容",
  "err_flag": false,
  "ended": false,
  "code": 0,
  "pwd_dir": "当前目录路径"
}

同步命令执行响应格式

{
  "ret": true,
  "msg": "success",
  "data": {
    "output": "标准输出内容",
    "error": "错误输出内容",
    "exitCode": 0,
    "success": true
  }
}

权限控制

  • 命令执行相关API（/systemcmd/run, /systemcmd/post, /systemcmd/pty, /systemcmd/run-sync）需要用户ID在 systemcmd-allows 文件中
  • 权限验证通过 systemcmd_allows_filter 中间件实现

元数据

{
  "sourceFile": "index.js",
  "generatedAt": "2026-01-30T12:21:52.167Z",
  "endpointCount": 20,
  "hasHttpApis": true
}

本文档由HTTP API文档生成Agent自动生成