用于类型脚本和 JavaScript 的 Cloudfleet SDK
正式类型SDK 云飞 API (英语).
云飞 是一个管理好的Kubernetes平台,它运行你的集群 穿过任何云层和你自己的光金属服务器。 这个SDK是一个完全打入的客户端,用于从Node.js,浏览器,或任何TypeScript项目中实现集群,车队,节点的自动化和计费.
安装
npm install @cloudfleet/sdk
使用量
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时的响应文本. 其他身体领域,如Kubernetesdetails开始body。 。 。 .CloudfleetNetworkError:没有收到答复。 卡莉丝method, (中文(简体) ),path, (中文(简体) ),url,和原件fetch错误为cause。 。 。 .
中止的请求和请求或响应验证错误不改变.
message 是服务器的文本并可以包含个人数据,例如用户在Kubernetes RBAC错误中的电子邮件. 向遥测报告错误时, 标题并按 method, (中文(简体) ), path 财务报告和审定财务报表 status,其中不包含身份或姓名.
KubernetesService 不管客户是谁 电话总是失败 throwOnError 设置.
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 通过 @cloudfleet/sdk/@tanstack/react-query见 云层文件 用于完整的 API 参考和认证细节.
许可证
麻省理工学院