LightCC光算云文档

切换主题

LightCC API 接入指南 ​

在使用 LightCC API 之前，您需要了解如何申请密钥和进行身份认证。本指南将帮助您快速开始使用我们的 API 服务。

申请密钥 ​

第一步：进入用户中心 ​

登录您的 LightCC 账户，进入用户中心，点击"安全设置"。

申请密钥

第二步：申请开通 API 密钥 ​

在安全设置页面中，申请开通 API 密钥功能。

第三步：查看密钥 ​

开通后刷新页面，点击"查看密钥"即可获取您的 API 密钥。请妥善保管密钥，避免泄露给他人。

查看密钥

⚠️ 重要提醒：API 密钥是您访问 API 服务的凭证，请妥善保管，不要将其分享给他人或在客户端代码中硬编码。

认证与请求方式 ​

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

Base URL ​

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

https://api.lightcc.cloud

请求方式 ​

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

请求头配置 ​

每个请求都需要包含以下请求头：

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

请求示例 ​

GET 请求示例 ​

bash
curl -X GET "https://api.lightcc.cloud/equipment/deviceServer/openApplication" \
     -H "X-Api-Key: YOUR_API_KEY"

POST 请求示例 ​

bash
curl -X POST "https://api.lightcc.cloud/equipment/deviceServer/openCreateApplication" \
     -H "X-Api-Key: YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "imageName": "Stable Difussion WebUI 官方版",
       "imageId": 5,
       "gpuModel": "4090",
       "numberOfGPUs": 1,
       "billingMethod": "0",
       "cycle": "0"
     }'

响应格式 ​

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

json
{
    "code": 200,
    "msg": "操作成功",
    "data": {
        // 具体数据内容
    }
}

响应字段说明 ​

字段类型说明
codeInteger响应状态码，200 表示成功
msgString响应消息，成功时通常为"操作成功"
dataObject/Array响应数据，具体内容根据接口而定

错误处理 ​

当请求失败时，API 会返回相应的错误信息：

json
{
    "code": 400,
    "msg": "请求参数错误",
    "data": null
}

常见错误码：

  • 400: 请求参数错误
  • 401: 认证失败，请检查 API 密钥
  • 403: 权限不足
  • 404: 资源不存在
  • 500: 服务器内部错误

开始使用 ​

完成以上步骤后，您就可以开始使用 LightCC 的 API 服务了：

技术支持 ​

如果您在使用 API 过程中遇到任何问题，请通过以下方式联系我们：

  • 官方客服：通过平台在线客服
  • 技术交流群：加入我们的开发者交流群
  • 邮件支持：发送邮件至技术支持邮箱