PCSMT2 文档

# 程序接口

# 分类

# 1. 常规

  • /api/program

使用方法:

GET /api/program

响应数据:


<h1>Welcome to PCSMT2 Program API!</h1>
  • /api/program/version 这个接口用于获取程序的版本号。 模版是版本号-发布类型 例如1.0.0-Release 发布类型包括:
    • Release
    • Beta
    • Alpha
    • Dev

使用方法:

GET /api/program/version

响应数据:

{
    "version": "1.0.0-Release"
}

# 2. 获取

  • /api/program/disk_usage 这个接口用于获取程序所在磁盘的使用情况。 获取到的数据:
    • disk_usage: 磁盘使用情况(%)
    • disk_free: 磁盘剩余情况(%)
    • usage: 磁盘使用量
    • free: 磁盘剩余量

使用方法

GET /api/program/disk_usage

响应数据:

{
    "disk_usage": "30%",
    "disk_free": "70%",
    "usage": "30GB",
    "free": "70GB"
}
  • /api/program/get/settings 这个接口用于获取程序的设置。 获取到的数据:
    • min_memory: 最小内存
    • max_memory: 最大内存
    • nogui_enabled: 是否启用无界面模式
    • eula_wait_time: EULA等待时间
    • auto_start: 是否开启开机自启动
    • update_source: 更新源
    • test_versions: 是否获取测试版本
    • storage_update_time: 存储更新时间
    • server_port: API Server 端口

使用方法:

GET /api/program/get/settings

响应数据

{
    "min_memory": 2048,
    "max_memory": 4096,
    "nogui_enabled": true,
    "eula_wait_time": 25,
    "auto_start": true,
    "update_source": "Github",
    "test_versions": false,
    "storage_update_time": 3600,
    "server_port": 5000,
}
  • /api/program/get/CPU/Usage 这个接口用于获取CPU占用率。 获取到的数据:
    • success: 是否成功
    • message: 提示信息
    • cpu_usage: CPU占用率(%)
    • total: 总CPU频率(MHz)
    • abs_used: 已用CPU频率(MHz)
    • abs_total: 总CPU频率(MHz)

使用方法:

GET /api/program/get/CPU/Usage

响应数据:

{
    "success": true,
    "message": "获取CPU占用率成功",
    "cpu_usage": "30%",
    "total": "3700MHz",
    "abs_used": "1100MHz",
    "abs_total": "3700MHz"
}
  • /api/program/get/RAM/Usage 这个接口用于获取RAM占用率。 获取到的数据:
    • success: 是否成功
    • message: 提示信息
    • ram_usage: RAM占用率(%)
    • total: 总RAM大小(MB)
    • abs_used: 已用RAM大小(MB)
    • abs_total: 总RAM大小(MB)

使用方法:

GET /api/program/get/RAM/Usage

响应数据:

{
    "success": true,
    "message": "获取RAM占用率成功",
    "ram_usage": "25%",
    "total": "8192MB",
    "abs_used": "2048MB",
    "abs_total": "8192MB"
}
  • /api/program/minecraft_version 这个接口用于获取Minecraft版本列表。 获取到的数据:
    • success: 是否成功
    • message: 提示信息
    • versions: Minecraft版本列表

使用方法:

GET /api/program/minecraft_version

响应数据:

{
    "version": ["1.21.8", "1.21.7", "1.21.6", "1.21.5", "1.21.4", "1.21.3", "1.21.2", "1.21.1", "1.21", "1.20.6", "1.20.5", "1.20.4", "1.20.3", "1.20.2", "1.20.1", "1.20", "1.19.4", "1.19.3", "1.19.2", "1.19.1", "1.19", "1.18.2", "1.18.1", "1.18", "1.17.1", "1.17", "1.16.5", "1.16.4", "1.16.3", "1.16.2", "1.16.1", "1.16", "1.15.2", "1.15.1", "1.15", "1.14.4", "1.14.3", "1.14.2", "1.14.1", "1.14", "1.13.2", "1.13.1", "1.13", "1.12.2", "1.12.1", "1.12", "1.11.2", "1.11.1", "1.11", "1.10.2", "1.10.1", "1.10", "1.9.4", "1.9.3", "1.9.2", "1.9.1", "1.9", "1.8.9", "1.8.8", "1.8.7", "1.8.6", "1.8.5", "1.8.4", "1.8.3", "1.8.2", "1.8.1", "1.8", "1.7.10", "1.7.9", "1.7.8", "1.7.7", "1.7.6", "1.7.5", "1.7.4", "1.7.3", "1.7.2", "1.7.1", "1.7", "1.6.4", "1.6.3", "1.6.2", "1.6.1", "1.6", "1.5.2", "1.5.1", "1.5", "1.4.7", "1.4.5", "1.4.6", "1.4.4", "1.4.3", "1.4.2", "1.4.1", "1.4", "1.3.2", "1.3.1", "1.3", "1.2.5", "1.2.4", "1.2.3", "1.2.2", "1.2.1", "1.1", "1.0"]
}

# 3. 设置

  • /api/program/set/settings 这个接口用于设置程序的设置。 请求参数:
    • min_memory: 最小内存
    • max_memory: 最大内存
    • nogui_enabled: 是否启用无界面模式
    • eula_wait_time: EULA等待时间
    • auto_start: 是否开启开机自启动
    • update_source: 更新源
    • test_versions: 是否获取测试版本
    • storage_update_time: 存储更新时间
    • server_port: API Server 端口

使用方法:

POST /api/program/set/settings

请求数据:

{
    "min_memory": 4096,
    "max_memory": 8192,
    "nogui_enabled": false,
    "eula_wait_time": 30,
    "auto_start": false,
    "update_source": "Gitee",
    "test_versions": true,
    "storage_update_time": 1800,
    "server_port": 8080,
}

响应数据:

{
    "success": true
}

← 服务器 API 接口 →