lucidlink/lucidlink-api

什么是LucidLink？

LucidLink是一个云原生文件系统，可从对象存储流式传输数据，支持从任何位置即时访问和实时协作大型文件，无需下载或同步整个文件。

使用入门

注册与账户要求

要使用LucidLink API容器，您必须是app.lucidlink.com的注册用户，并满足以下前提条件：

1. 已创建一个工作区（workspace）。
2. 是该工作区的管理员。
3. 拥有Business或Enterprise订阅。更多信息请查看定价页面。

关于工作区所有者入门的详细指南，请参考： 工作区所有者入门

服务账户

LucidLink API仅通过专用的服务账户访问，此功能仅对Business和Enterprise账户用户开放：

• 每个服务账户可拥有多个密钥。
• 与容器交互需要有效的密钥进行身份验证。

关于服务账户的设置和管理，请参考知识库： lucidlink.com/kb-service-accounts

镜像使用方法

您可以通过以下Docker命令运行LucidLink API容器：

bash
docker run -p 3003:3003 docker.xuanyuan.run/lucidlink/lucidlink-api:latest

确认与健康检查

您可以通过基础健康检查确认容器是否正常运行：

bash
curl -i -X GET 'http://localhost:3003/api/v1/health'

带授权的示例查询

大多数操作需要使用服务账户的密钥进行授权，例如：

bash
curl -i -X GET 'http://localhost:3003/api/v1/filespaces' -H 'Authorization: Bearer [您的服务密钥]' -H 'Content-Type: application/json'

此命令将返回服务账户所在工作区的所有文件空间列表。

API文档

容器启动并正常运行后，您可以通过以下链接访问交互式Swagger API文档： http://localhost:3003/api/v1/docs

镜像变体与标签

我们目前提供两个主要的LucidLink API容器镜像标签：

• latest：代表最新的稳定版本。
• 版本化标签（如1.0.0）：提供特定的稳定版本，以增强兼容性。

未来将引入更多具体的版本化标签，确保持续稳定性。

维护与支持

如果您遇到任何问题或需要帮助，我们的支持团队随时为您服务：

• 提交工单：[***]
• 在线聊天：在支持门户[***]
• 发送邮件：***

1.4.4版本更新内容

• 外部链接API：可选的大小和校验和参数
  外部链接API在创建外部文件条目时现在接受可选的size和checksum字段。提供这些字段时，API将跳过对外部URL的HEAD请求，减少延迟并消除链接创建时对远程服务器可达性的依赖。
  • SingleObjectFileParams：接受包含size和checksum的可选metadata对象
  • HttpFileParams：接受可选的size参数