LightCC-API文档

申请密钥

第一步： 进入用户中心，点击“安全设置”，申请开通 API 密钥。

第二步： 开通后刷新页面，点击“查看密钥”即可。请妥善保管密钥，避免泄露给他人。

认证与请求方式

在成功申请 API 密钥后，所有请求都需要携带密钥进行身份认证。

Base URL

所有 API 请求都应基于以下 Base URL 进行访问：

https://api.lightcc.cloud

请求方式

LightCC API 采用 RESTful 规范，支持 GET 和 POST 请求，所有请求必须在 Header 中添加 X-Api-Key 进行身份认证。

请求头示例

`X-Api-Key`: YOUR_API_KEY
Content-Type: application/json

示例请求

GET 请求示例

curl -X GET "https://api.lightcc.cloud/code" \
     -H "X-Api-Key: YOUR_API_KEY"

POST 请求示例

curl -X POST "https://api.lightcc.cloud/code" \
     -H "X-Api-Key:YOUR_API_KEY"
     -H "Content-Type:application/json" \
     -d '{"param1": "value1", "param2": "value2"}'

应用管理

我的应用

接口描述
获取用户的应用列表
请求方式
GET /equipment/deviceServer/openApplication
请求参数
参数名类型必填说明位置
runningState String 否运行状态 1：运行中、2：即将到期、3：即将卸载 Query 参数

参数名	类型	必填	说明	位置
runningState	String	否	运行状态 1：运行中、2：即将到期、3：即将卸载	Query 参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "startTime": "2025-03-12 15:15:42", // 开机时间
            "aId": "1899720917190184960", // 应用ID
            "aApplicationName": null, // 应用名
            "aContainerId": "bbcbb3b2894040efb8c0de7356891d4d", // 容器ID
            "aStatus": "1", // 状态(0:创建中、1:运行中、2:关机、3:启动中、4:关机中、5:未知、6:销毁、7:异常、8:重启中)
            "aSystem": "0", // 系统 (0:Linux、1:Windows)
            "aBillingMode": "0", // 计费模式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)
            "sRentalPrice": 1.98, // 价格
            "sConsume": 0.06, // 本次消耗
            "aImageId": 5, // 镜像ID
            "imageTitle": "Stable Difussion WebUI 官方版", // 镜像标题
            "cpuModel": "AMD EPYC 7542 32-Core Processor", // cpu型号
            "aGpuNumbers": 1, // GPU数量
            "aSystemDisk": 20971520, // 系统盘
            "aDataDisk": 52428800, // 数据盘
            "aSort": 0, // 排序
            "gpuModel": "4090", // gpu型号
            "cpuCores": 16, // cpu核心
            "gpuMemorySize": 25165824, // 显存容量(kb)
            "memorySize": 61902684, // 内存存储容量(kb)
            "createTime": "2025-03-12 15:15:37", // 创建时间
            "stopTime": null // 关机时间
        }
    ]
}

应用详情

接口描述
根据应用ID查看应用详细的信息
请求方式
GET /equipment/deviceServer/openApplicationDetails/{aId}
请求参数
参数名类型必填说明位置
aId String 是应用ID 路径参数

参数名	类型	必填	说明	位置
aId	String	是	应用ID	路径参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "appLink": "https://ayqcxbnn94uoqrg6xc2y06g0rhx2ri5qiyx1jaw:online.lightcc.cloud", // 应用链接
        "aId": "1899720917190184960", // 应用ID
        "aApplicationName": null, // 应用名
        "aContainerId": "bbcbb3b2894040efb8c0de7356891d4d", // 容器ID
        "aStatus": "1", // 状态(0:创建中、1:运行中、2:关机、3:启动中、4:关机中、5:未知、6:销毁、7:异常、8:重启中)
        "aSystem": "0", // 系统 (0:Linux、1:Windows)
        "aBillingMode": "0", // 计费模式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)
        "sRentalPrice": 1.98, // 价格
        "sConsume": 0.06, // 本次消耗
        "aImageId": 5, // 镜像ID
        "imageTitle": "Stable Difussion WebUI 官方版", // 镜像标题
        "cpuModel": "AMD EPYC 7542 32-Core Processor", // cpu型号
        "aGpuNumbers": 1, // GPU数量
        "aSystemDisk": 20971520, // 系统盘
        "aDataDisk": 52428800, // 数据盘
        "aSort": 0, // 排序
        "gpuModel": "4090", // gpu型号
        "cpuCores": 16, // cpu核心
        "gpuMemorySize": 25165824, // 显存容量(kb)
        "memorySize": 61902684, // 内存存储容量(kb)
        "createTime": "2025-03-12 15:15:37", // 创建时间
        "stopTime": null // 关机时间
    }
}

创建应用

接口描述
用于创建一个新的应用。应用创建后，将分配唯一的 aId，可用于后续的 API 调用和管理。
请求方式
POST /equipment/deviceServer/openCreateApplication

请求参数

参数名	类型	必填	说明	位置
imageName	String	是	镜像标签	body参数
imageId	Integer	是	镜像ID	body参数
gpuModel	String	是	GPU型号	body参数
numberOfGPUs	Integer	是	GPU数量	body参数
billingMethod	String	是	计费方式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)	body参数
cycle	String	是	周期：按量计费可填写0，整租填写数字即可	body参数

返回示例

json

{
    "msg": "1933362172036460544", // 应用ID
    "code": 200,
}

启动应用

接口描述
启动/重启指定的应用程序，恢复其运行状态。
请求方式
POST /equipment/deviceServer/openRestartApplication/{aId}
请求参数
参数名类型必填说明位置
aId String 是应用ID 路径参数

参数名	类型	必填	说明	位置
aId	String	是	应用ID	路径参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": 1
}

停止应用

接口描述
停止指定的应用程序，不会删除应用，但会暂停其运行。
请求方式
POST /equipment/deviceServer/openStopApplication/{aId}
请求参数
参数名类型必填说明位置
aId String 是应用ID 路径参数

参数名	类型	必填	说明	位置
aId	String	是	应用ID	路径参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": 1
}

定时停止应用

接口描述
定时停止指定的应用程序，不会删除应用，但会暂停其运行。
请求方式
GET /equipment/deviceServer/openTimedStopApplication/{aId}
请求参数
参数名类型必填说明位置
aId String 是应用ID 路径参数
stopTime String 是停止时间（格式：yyyy-MM-dd hh:mm:ss） query参数

参数名	类型	必填	说明	位置
aId	String	是	应用ID	路径参数
stopTime	String	是	停止时间（格式：yyyy-MM-dd hh:mm:ss）	query参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
}

销毁应用

接口描述
销毁指定的应用，删除应用的所有相关数据和配置，且不可恢复
请求方式
POST /equipment/deviceServer/openDestructionApplication/{aId}
请求参数
参数名类型必填说明位置
aId String 是应用ID 路径参数

参数名	类型	必填	说明	位置
aId	String	是	应用ID	路径参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": 1
}

获取应用链接

接口描述
根据应用ID、类型获取指定的链接信息
请求方式
POST /equipment/deviceServer/applicationLinks/{type}/{aId}
请求参数
参数名类型必填说明位置
type String 是链接类型(1:Jupyter、2:Filebrowser、3:SD) 路径参数
aId String 是应用ID 路径参数

参数名	类型	必填	说明	位置
type	String	是	链接类型(1:Jupyter、2:Filebrowser、3:SD)	路径参数
aId	String	是	应用ID	路径参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "domainName": "ccksan.lightcc.cloud", // 域名
        "dynamicUrl": "xs90djahsosad", // 前缀
    }
}

镜像管理

镜像列表

接口描述
查询镜像列表
请求方式
GET /system/applicationImage/openListByUser
请求参数
参数名类型必填说明位置
title String 否镜像名 Query参数

参数名	类型	必填	说明	位置
title	String	否	镜像名	Query参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "createBy": "",
            "createTime": null,
            "updateBy": "",
            "updateTime": null,
            "remark": null,
            "id": 5, // 镜像ID
            "typeId": 2,
            "authorId": 1,
            "coverImg": "00004.png",
            "coverImgUrl": "https://minio.lightcc.cloud/img/00004.png", // 镜像封面url
            "title": "Stable Difussion WebUI 官方版", // 镜像名称
            "likeNum": 142, // 点赞量
            "like": 1, // 点赞 1点赞、0未点赞
            "likeTime": "2024-10-21T10:29:25.000+08:00", // 点赞时间
            "description": "直观的图形界面，对新手用户友好。", // 介绍
            "ports": "22,8890,8888", // 端口号
            "fileDirectory": "official/xingshuai-webui:v6", // 镜像标签
            "runningTime": 0,
            "status": "1", 
            "systemType": "0", // 系统类型(0:Linux、1: Windows)
            "isAppOnly": "0", //  是否只提供app服务(0否、1是)
            "orderNum": -1,
            "imageSize": null,
            "price": 0.0, // 镜像价格
        }
    ]
}

根据镜像ID获取镜像信息

接口描述
传入镜像的ID,查询镜像的详细信息
请求方式
GET /system/applicationImage/openGetInfoById/{imageId}
请求参数
参数名类型必填说明位置
imageId String 是镜像ID Query参数

参数名	类型	必填	说明	位置
imageId	String	是	镜像ID	Query参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "createBy": "admin",
        "createTime": "2024-04-23 17:10:46",
        "updateBy": "18246275703",
        "updateTime": "2025-06-03 18:58:54",
        "remark": null,
        "id": 6, // 镜像ID
        "typeId": 4,
        "authorId": 1,
        "coverImg": "000012.png", // 封面图
        "title": "ComfyUI 官方版", // 镜像名称
        "likeNum": 0, // 点赞数量
        "like": null,
        "likeTime": null,
        "description": "工作流式的Stable Diffusion图形用户界面", // 镜像简介
        "ports": "22,8890",
        "fileDirectory": "official/xingshuai-comfyui:v6", // 镜像标签
        "runningTime": 0,
        "status": "1",
        "systemType": "0",
        "isAppOnly": "0",
        "sysUser": null,
        "orderNum": -1,
        "imageSize": null,
        "originalImageId": null,
        "fromContainerName": null,
        "applicationImageType": {
            "createBy": null,
            "createTime": null,
            "updateBy": null,
            "updateTime": null,
            "remark": null,
            "id": 4,
            "name": "ComfyUI",
            "parentId": null,
            "children": null,
            "orderNum": null,
            "status": null
        },
        "price": 0.0,
        "coverImgUrl": null,
        "applicationId": null,
        "originalImageName": null,
        "isShare": null,
        "typeIds": [],
        "contentOfFourses": null,
        "worksShow": null
    }
}

根据镜像ID查询可用GPU

接口描述
传入镜像的ID,查询能够使用的GPU型号
请求方式
GET /equipment/deviceServer/openAvailableGpuConfig
请求参数
参数名类型必填说明位置
imageId String 是镜像ID Query参数

参数名	类型	必填	说明	位置
imageId	String	是	镜像ID	Query参数

返回示例

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "gpuMemory": "24",
            "available": true, // true 表示可用，false 表示用完
            "gpu": "4090",
            "maxAvailable": 8 // 单台最大可用数量
        },
        {
            "gpuMemory": "24",
            "available": true,
            "gpu": "3090",
            "maxAvailable": 10
        },
        {
            "gpuMemory": "16",
            "available": false,
            "gpu": "4070 Ti SUPER",
            "maxAvailable": 8
        },
        {
            "gpuMemory": "12",
            "available": false,
            "gpu": "3060",
            "maxAvailable": 7
        },
        {
            "gpuMemory": "22",
            "available": false,
            "gpu": "2080 Ti",
            "maxAvailable": 4
        },
        {
            "gpuMemory": "40",
            "available": false,
            "gpu": "A100",
            "maxAvailable": 6
        }
    ]
}

获取GPU价格

接口描述
传入参数，获取GPU价格信息
请求方式
GET /recharge/charge/getGpuPrice

请求参数

参数名	类型	必填	说明	位置
gpuModel	String	是	GPU型号	Query参数
gpuCount	String	是	GPU数量	Query参数
billingMode	String	是	计费方式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)	Query参数
cycle	String	是	周期：按量计费可填写0，整租填写数字即可	Query参数

返回示例

json

{
    "code": 200,
    "msg": null,
    "data": {
        "3060": 0.62, // GPU实际价格
        "discountPrice": 0.01, // 优惠价格
        "gpuModelPrice": 0.63 // 原价
    }
}

账户相关

账户余额

接口描述
销毁指定的应用，删除应用的所有相关数据和配置，且不可恢复
请求方式
POST /recharge/order-info/openSelectBalance

返回示例

json

{
    "code": 200,
    "msg": "查询成功",
    "data": {
        "balance": 99.99, // 余额
        "voucher": 216.22, // 代金劵
        "hashrateBalance": 237972 // 算力点
    }
}

LightCC-API文档 ​

申请密钥 ​

认证与请求方式 ​

Base URL ​

请求方式 ​

请求头示例 ​

示例请求 ​

应用管理 ​

我的应用 ​

应用详情 ​

创建应用 ​

启动应用 ​

停止应用 ​

定时停止应用 ​

销毁应用 ​

获取应用链接 ​

镜像管理 ​

镜像列表 ​

根据镜像ID获取镜像信息 ​

根据镜像ID查询可用GPU ​

获取GPU价格 ​

账户相关 ​

账户余额 ​

LightCC-API文档

申请密钥

认证与请求方式

Base URL

请求方式

请求头示例

示例请求

应用管理

我的应用

应用详情

创建应用

启动应用

停止应用

定时停止应用

销毁应用

获取应用链接

镜像管理

镜像列表

根据镜像ID获取镜像信息

根据镜像ID查询可用GPU

获取GPU价格

账户相关

账户余额