跳到主要内容

API 文档

欢迎使用 PveSphere API 文档。本文档提供了完整的 API 接口说明。

基础信息​

Base URL​

http://localhost:8000/api/v1

认证方式​

PveSphere API 使用 JWT (JSON Web Token) 进行身份验证。

获取 Token​

POST /api/v1/user/login
Content-Type: application/json

{
  "email": "pvesphere@gmail.com",
  "password": "Ab123456"
}

响应示例：

{
  "code": 200,
  "message": "success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "user": {
      "id": 1,
      "email": "pvesphere@gmail.com",
      "nickname": "PveSphere Admin"
    }
  }
}

使用 Token​

在后续请求中，需要在请求头中携带 Token：

Authorization: Bearer <your-token>

API 概览​

认证与授权​

集群管理​

节点管理​

虚拟机管理​

存储管理​

模板管理​

响应格式​

所有 API 响应都遵循统一的格式：

{
  "code": 200,
  "message": "success",
  "data": {}
}

状态码​

  • 200 - 成功
  • 400 - 请求参数错误
  • 401 - 未授权
  • 403 - 禁止访问
  • 404 - 资源不存在
  • 500 - 服务器错误

Swagger 文档​

您也可以通过 Swagger UI 查看完整的 API 文档：

http://localhost:8000/swagger/index.html

下一步​