LightCC 平台 API 文档

💡 提示：在使用本 API 之前，请先阅读 API接入指南，了解如何申请密钥和进行身份认证。

应用管理

我的应用

GET /equipment/deviceServer/openApplication

获取用户的应用列表

请求参数

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

响应参数

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "startTime": "2025-03-12 15:15:42",
            "aId": "1899720917190184960",
            "aApplicationName": null,
            "aContainerId": "bbcbb3b2894040efb8c0de7356891d4d",
            "aStatus": "1",
            "aSystem": "0",
            "aBillingMode": "0",
            "sRentalPrice": 1.98,
            "sConsume": 0.06,
            "aImageId": 5,
            "imageTitle": "Stable Difussion WebUI 官方版",
            "cpuModel": "AMD EPYC 7542 32-Core Processor",
            "aGpuNumbers": 1,
            "aSystemDisk": 20971520,
            "aDataDisk": 52428800,
            "aSort": 0,
            "gpuModel": "4090",
            "cpuCores": 16,
            "gpuMemorySize": 25165824,
            "memorySize": 61902684,
            "createTime": "2025-03-12 15:15:37",
            "stopTime": null
        }
    ]
}

名称	类型	备注
startTime	String	开机时间
aId	String	应用ID
aApplicationName	String	应用名
aContainerId	String	容器ID
aStatus	String	状态(0:创建中、1:运行中、2:关机、3:启动中、4:关机中、5:未知、6:销毁、7:异常、8:重启中)
aSystem	String	系统 (0:Linux、1:Windows)
aBillingMode	String	计费模式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)
sRentalPrice	Number	价格
sConsume	Number	本次消耗
aImageId	Number	镜像ID
imageTitle	String	镜像标题
cpuModel	String	cpu型号
aGpuNumbers	Number	GPU数量
aSystemDisk	Number	系统盘
aDataDisk	Number	数据盘
aSort	Number	排序
gpuModel	String	gpu型号
cpuCores	Number	cpu核心
gpuMemorySize	Number	显存容量(kb)
memorySize	Number	内存存储容量(kb)
createTime	String	创建时间
stopTime	String	关机时间

应用详情

GET /equipment/deviceServer/openApplicationDetails/{aId}

根据应用ID查看应用详细的信息

请求参数

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

响应参数

json

{
    "msg": "操作成功",
    "code": 200,
    "data": {
        "appLink": "https://ayqcxbnn94uoqrg6xc2y06g0rhx2ri5qiyx1jaw:online.lightcc.cloud",
        "aId": "1899720917190184960",
        "aApplicationName": null,
        "aContainerId": "bbcbb3b2894040efb8c0de7356891d4d",
        "aStatus": "1",
        "aSystem": "0",
        "aBillingMode": "0",
        "sRentalPrice": 1.98,
        "sConsume": 0.06,
        "aImageId": 5,
        "imageTitle": "Stable Difussion WebUI 官方版",
        "cpuModel": "AMD EPYC 7542 32-Core Processor",
        "aGpuNumbers": 1,
        "aSystemDisk": 20971520,
        "aDataDisk": 52428800,
        "aSort": 0,
        "gpuModel": "4090",
        "cpuCores": 16,
        "gpuMemorySize": 25165824,
        "memorySize": 61902684,
        "createTime": "2025-03-12 15:15:37",
        "stopTime": null
    }
}

名称	类型	备注
appLink	String	应用链接
aId	String	应用ID
aApplicationName	String	应用名
aContainerId	String	容器ID
aStatus	String	状态(0:创建中、1:运行中、2:关机、3:启动中、4:关机中、5:未知、6:销毁、7:异常、8:重启中)
aSystem	String	系统 (0:Linux、1:Windows)
aBillingMode	String	计费模式 (0:按量计费、1:包天、2:包周、3:包月、4:包年)
sRentalPrice	Number	价格
sConsume	Number	本次消耗
aImageId	Number	镜像ID
imageTitle	String	镜像标题
cpuModel	String	cpu型号
aGpuNumbers	Number	GPU数量
aSystemDisk	Number	系统盘
aDataDisk	Number	数据盘
aSort	Number	排序
gpuModel	String	gpu型号
cpuCores	Number	cpu核心
gpuMemorySize	Number	显存容量(kb)
memorySize	Number	内存存储容量(kb)
createTime	String	创建时间
stopTime	String	关机时间

创建应用

POST /equipment/deviceServer/openCreateApplication

用于创建一个新的应用。应用创建后，将分配唯一的 aId，可用于后续的 API 调用和管理。

请求参数

json

{
    "imageName": "Stable Difussion WebUI 官方版",
    "imageId": 5,
    "gpuModel": "4090",
    "numberOfGPUs": 1,
    "billingMethod": "0",
    "cycle": "0"
}

参数名	类型	必填	说明	位置
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",
    "code": 200
}

名称	类型	备注
msg	String	应用ID
code	Number	状态码

启动应用

POST /equipment/deviceServer/openRestartApplication/{aId}

启动/重启指定的应用程序，恢复其运行状态。

请求参数

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

响应参数

json

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

名称	类型	备注
msg	String	响应消息
code	Number	状态码
data	Number	操作结果

停止应用

POST /equipment/deviceServer/openStopApplication/{aId}

停止指定的应用程序，不会删除应用，但会暂停其运行。

请求参数

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

响应参数

json

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

名称	类型	备注
msg	String	响应消息
code	Number	状态码
data	Number	操作结果

定时停止应用

GET /equipment/deviceServer/openTimedStopApplication/{aId}

定时停止指定的应用程序，不会删除应用，但会暂停其运行。

请求参数

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

响应参数

json

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

名称	类型	备注
msg	String	响应消息
code	Number	状态码

销毁应用

POST /equipment/deviceServer/openDestructionApplication/{aId}

销毁指定的应用，删除应用的所有相关数据和配置，且不可恢复

请求参数

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

响应参数

json

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

名称	类型	备注
msg	String	响应消息
code	Number	状态码
data	Number	操作结果

获取应用链接

POST /equipment/deviceServer/applicationLinks/{type}/{aId}

根据应用ID、类型获取指定的链接信息

请求参数

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

响应参数

json

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

名称	类型	备注
domainName	String	域名
dynamicUrl	String	前缀

镜像管理

镜像列表

GET /system/applicationImage/openListByUser

查询镜像列表

请求参数

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

响应参数

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "createBy": "",
            "createTime": null,
            "updateBy": "",
            "updateTime": null,
            "remark": null,
            "id": 5,
            "typeId": 2,
            "authorId": 1,
            "coverImg": "00004.png",
            "coverImgUrl": "https://minio.lightcc.cloud/img/00004.png",
            "title": "Stable Difussion WebUI 官方版",
            "likeNum": 142,
            "like": 1,
            "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",
            "isAppOnly": "0",
            "orderNum": -1,
            "imageSize": null,
            "price": 0.0
        }
    ]
}

名称	类型	备注
id	Number	镜像ID
typeId	Number	类型ID
authorId	Number	作者ID
coverImg	String	封面图
coverImgUrl	String	镜像封面url
title	String	镜像名称
likeNum	Number	点赞量
like	Number	点赞 1点赞、0未点赞
likeTime	String	点赞时间
description	String	介绍
ports	String	端口号
fileDirectory	String	镜像标签
runningTime	Number	运行时间
status	String	状态
systemType	String	系统类型(0:Linux、1: Windows)
isAppOnly	String	是否只提供app服务(0否、1是)
orderNum	Number	排序号
imageSize	Number	镜像大小
price	Number	镜像价格

根据镜像ID获取镜像信息

GET /system/applicationImage/openGetInfoById/{imageId}

传入镜像的ID,查询镜像的详细信息

请求参数

参数名	类型	必填	说明	位置
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,
        "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	Number	镜像ID
typeId	Number	类型ID
authorId	Number	作者ID
coverImg	String	封面图
title	String	镜像名称
likeNum	Number	点赞数量
like	Number	点赞状态
likeTime	String	点赞时间
description	String	镜像简介
ports	String	端口号
fileDirectory	String	镜像标签
runningTime	Number	运行时间
status	String	状态
systemType	String	系统类型(0:Linux、1: Windows)
isAppOnly	String	是否只提供app服务(0否、1是)
sysUser	String	系统用户
orderNum	Number	排序号
imageSize	Number	镜像大小
originalImageId	Number	原始镜像ID
fromContainerName	String	来源容器名称
applicationImageType	Object	应用镜像类型信息
price	Number	镜像价格
coverImgUrl	String	封面图片URL
applicationId	Number	应用ID
originalImageName	String	原始镜像名称
isShare	Number	是否分享
typeIds	Array	类型ID列表
contentOfFourses	String	四小时内容
worksShow	String	作品展示

根据镜像ID查询可用GPU

GET /equipment/deviceServer/openAvailableGpuConfig

传入镜像的ID,查询能够使用的GPU型号

请求参数

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

响应参数

json

{
    "msg": "操作成功",
    "code": 200,
    "data": [
        {
            "gpuMemory": "24",
            "available": true,
            "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
        }
    ]
}

名称	类型	备注
gpuMemory	String	GPU显存大小
available	Boolean	true 表示可用，false 表示用完
gpu	String	GPU型号
maxAvailable	Number	单台最大可用数量

获取GPU价格

GET /recharge/charge/getGpuPrice

传入参数，获取GPU价格信息

请求参数

参数名	类型	必填	说明	位置
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,
        "discountPrice": 0.01,
        "gpuModelPrice": 0.63
    }
}

名称	类型	备注
3060	Number	GPU实际价格
discountPrice	Number	优惠价格
gpuModelPrice	Number	原价

账户相关

账户余额

GET /recharge/order-info/openSelectBalance

查询账户当前可用余额信息，支持获取账户内的可用金额、代金劵、算力点等数据，便于用户掌握账户资金情况。

响应参数

json

{
    "code": 200,
    "msg": "查询成功",
    "data": {
        "balance": 99.99,
        "voucher": 216.22,
        "hashrateBalance": 237972
    }
}

名称	类型	备注
balance	Number	余额
voucher	Number	代金劵
hashrateBalance	Number	算力点

LightCC 平台 API 文档 ​

应用管理 ​

我的应用 ​

请求参数 ​

响应参数 ​

应用详情 ​

请求参数 ​

响应参数 ​

创建应用 ​

请求参数 ​

响应参数 ​

启动应用 ​

请求参数 ​

响应参数 ​

停止应用 ​

请求参数 ​

响应参数 ​

定时停止应用 ​

请求参数 ​

响应参数 ​

销毁应用 ​

请求参数 ​

响应参数 ​

获取应用链接 ​

请求参数 ​

响应参数 ​

镜像管理 ​

镜像列表 ​

请求参数 ​

响应参数 ​

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

请求参数 ​

响应参数 ​

根据镜像ID查询可用GPU ​

请求参数 ​

响应参数 ​

获取GPU价格 ​

请求参数 ​

响应参数 ​

账户相关 ​

账户余额 ​

响应参数 ​

LightCC 平台 API 文档

应用管理

我的应用

请求参数

响应参数

应用详情

请求参数

响应参数

创建应用

请求参数

响应参数

启动应用

请求参数

响应参数

停止应用

请求参数

响应参数

定时停止应用

请求参数

响应参数

销毁应用

请求参数

响应参数

获取应用链接

请求参数

响应参数

镜像管理

镜像列表

请求参数

响应参数

根据镜像ID获取镜像信息

请求参数

响应参数

根据镜像ID查询可用GPU

请求参数

响应参数

获取GPU价格

请求参数

响应参数

账户相关

账户余额

响应参数