# @cloudfleet/sdk 中文文档

规范地址：https://npmcn.com/package/%40cloudfleet/sdk/

版本：1\.13\.0
npm 元数据更新时间：2026-11-16T22:01:10.058Z
中文译文更新时间：2026-11-17T06:59:28.303Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudfleet/sdk
原文对照：https://npmcn.com/package/%40cloudfleet/sdk/?lang=original
项目主页：https://cloudfleet.ai/

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.3 MB，98 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：zod ^4\.4\.0，react ^18 \|\| ^19，@tanstack/react-query ^5\.0\.0
- 首次发布：2025-01-21T22:13:37.733Z
- 最新版本发布：2026-11-16T22:01:09.882Z
- 近 30 天下载量：5390（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：492（近 12 个月 326 个）

## 中文简介

正式的 Cloudfleet 管理库伯内特 API 的 TypeScript/ JavaScript SDK

## 安装

```sh
npm install @cloudfleet/sdk
```

也可以使用：`pnpm add @cloudfleet/sdk`、`yarn add @cloudfleet/sdk`、`bun add @cloudfleet/sdk`

## README

# 用于类型脚本和 JavaScript 的 Cloudfleet SDK

正式类型SDK [云飞](https://cloudfleet.ai/) API (英语).

[云飞](https://cloudfleet.ai/) 是一个管理好的Kubernetes平台,它运行你的集群 穿过任何云层和你自己的光金属服务器。 这个SDK是一个完全打入的客户端,用于从Node.js,浏览器,或任何TypeScript项目中实现集群,车队,节点的自动化和计费.

-   QQ 主页 : [云飞.ai](https://cloudfleet.ai/)
-   医生: [云浮.ai/文档](https://cloudfleet.ai/docs)

## 安装

```bash
npm install @cloudfleet/sdk
```

## 使用量

```ts
import { client } from "@cloudfleet/sdk";

client.setConfig({
    baseUrl: "https://api.cloudfleet.ai/v1",
    headers: {
        Authorization: "Bearer <your-token>",
    },
});
```

## 错误

请求抛出失败( 或返回为 `error` 何时 `throwOnError` 实值 `false`(中文(简体) ) `Error` 子类 :

-   `CloudfleetApiError`:API以非-2xx状态回答. 卡莉丝 `status`, (中文(简体) ), `method`, (中文(简体) ), `path` (路由模板,例如:. `/clusters/{cluster_id}`, (中文(简体) ), `url`, (中文(简体) ), `requestId`, (中文(简体) ), `code`, (中文(简体) ), `reason` (库伯涅斯) `Status.reason` ),和解析的响应 `body`。 。 。 . `message` 是尸体的吗 `message`,或者当身体不是JSON时的响应文本. 其他身体领域,如Kubernetes `details`开始 `body`。 。 。 .
-   `CloudfleetNetworkError`:没有收到答复。 卡莉丝 `method`, (中文(简体) ), `path`, (中文(简体) ), `url`,和原件 `fetch` 错误为 `cause`。 。 。 .

中止的请求和请求或响应验证错误不改变.

`message` 是服务器的文本并可以包含个人数据,例如用户在Kubernetes RBAC错误中的电子邮件. 向遥测报告错误时, 标题并按 `method`, (中文(简体) ), `path` 财务报告和审定财务报表 `status`,其中不包含身份或姓名.

`KubernetesService` 不管客户是谁 电话总是失败 `throwOnError` 设置.

```ts
import { CloudfleetApiError, ClustersService } from "@cloudfleet/sdk";

try {
    await ClustersService.getCluster({
        path: { cluster_id: id },
        throwOnError: true,
    });
} catch (err) {
    if (err instanceof CloudfleetApiError && err.status === 404) {
        // cluster does not exist
    }
}
```

默认 `client` 自动转换错误。 对于一个客户 `createClient`,以 `registerCloudfleetErrors(myClient)`。 。 。 .

包件船的完整类型和可选 [`@tanstack/react-query`](https://tanstack.com/query) 通过 `@cloudfleet/sdk/@tanstack/react-query`见 [云层文件](https://cloudfleet.ai/docs) 用于完整的 API 参考和认证细节.

## 许可证

麻省理工学院

## 常见问题

### @cloudfleet/sdk 是什么？

正式的 Cloudfleet 管理库伯内特 API 的 TypeScript/ JavaScript SDK

### 如何安装 @cloudfleet/sdk？

在项目目录运行 npm install @cloudfleet/sdk，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^4\.4\.0）、react（^18 \|\| ^19）、@tanstack/react-query（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cloudfleet/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cloudfleet/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cloudfleet/sdk 可以商用吗？

@cloudfleet/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudfleet/sdk 的下载量有多少？

根据 npm 官方下载统计，@cloudfleet/sdk 在 2026/10/10 – 2026/11/08 这 30 天内被下载 5,390 次，日均约 180 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cloudfleet/sdk 还在维护吗？

最新版本 1\.13\.0 发布于 2026/11/17（今天）；至今共发布 492 个版本，其中过去 12 个月发布了 326 个；首次发布于 2025/01/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

