SuperAPI AI 工具集

cloudcannon-sdk

编程与开发

查看项目

更新于 10-15 19:50

技能介绍

用途:@cloudcannon/sdk 是 CloudCannon CLI 所基于的 REST API 客户端,适合在脚本、构建步骤或服务中以编程方式调用 CloudCannon API,例如批量操作多个站点或组织、访问 CLI 未暴露的接口(DAM、备份、同步历史与拉取、站点扫描、截图、服务商连接/断开、site.copy、site.delete),以及按类型而非退出码处理 API 失败。若只是执行一次性 shell 命令,应使用 cloudcannon-cli;本地运行站点由 cloudcannon-dev-server 负责;cloudcannon.config.yml 的内容决策属于 cloudcannon-configuration,SDK 只按字节读写该文件。

主要能力:提供按层级组织的子客户端,以及可访问未被封装端点的类型化 fetch。子客户端只接受 UUID,因此多数任务需先解析 UUID。

使用方式:要求 Node 20 或更高版本,包为 ESM,默认导出客户端类。示例:import CloudCannonClient from "@cloudcannon/sdk"; 构造时需自行提供凭据,SDK 不读取磁盘或环境中的登录信息。

限制与注意:任何写入托管站点的调用前必须与用户确认,client.fetch 的 POST 同样属于写入。site.delete()、site.copy()、disconnectSourceProvider()、disconnectOutputProvider() 等破坏性端点没有命令行确认提示。分页端点只返回一页,需检查 total_pages。部分方法返回 Response 而非文件内容。方法签名随版本变化,应从已安装包中读取。不存在 client.sites(),站点按组织列出。