# @alienplatform/manager-api 中文文档

规范地址：https://npmcn.com/package/%40alienplatform/manager-api/

版本：3\.3\.54
npm 元数据更新时间：2026-11-05T10:26:39.004Z
中文译文更新时间：2026-11-06T08:46:42.768Z
软件包许可：FSL-1\.1-Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40alienplatform/manager-api
原文对照：https://npmcn.com/package/%40alienplatform/manager-api/?lang=original
项目主页：https://alien.dev/
源码仓库：https://github.com/alienplatform/alien

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

- 包体积（解压后）：3.9 MB，2230 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-04-16T08:35:53.185Z
- 最新版本发布：2026-11-05T10:26:38.834Z
- 近 30 天下载量：3729（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：95（近 12 个月 95 个）

## 中文简介

开发者友好型和型号安全型 SDK 专门适应杠杆 _@alienplaft/manager-api (英语)_ API (英语).

## 安装

```sh
npm install @alienplatform/manager-api
```

也可以使用：`pnpm add @alienplatform/manager-api`、`yarn add @alienplatform/manager-api`、`bun add @alienplatform/manager-api`

## README

# @alienplaft/manager-api (英语)

开发者友好型和型号安全型 SDK 专门适应杠杆 _@alienplaft/manager-api (英语)_ API (英语).

[![Built by Speakeasy](https://img.shields.io/badge/Built_by-SPEAKEASY-374151?style=for-the-badge&labelColor=f3f4f6)](https://www.speakeasy.com/?utm_source=@alienplatform/manager-api&utm_campaign=typescript) [![License: MIT](https://img.shields.io/badge/LICENSE_//_MIT-3b5bdb?style=for-the-badge&labelColor=eff6ff)](https://opensource.org/licenses/MIT)

  
  

> \[大 这个SDK还没有准备好用于生产. 为完成设置,请遵循您在《公约》 [工作空间](https://app.speakeasy.com/org/alien/alien)。在 > 发布到软件包管理器之前删除本节.

## 内容提要

外星管理人API:用于外星应用的控制平面. 管理部署、发布、命令和遥测.

## 目录

-   [@alienplaft/manager-api (英语)](https://npmcn.com/package/%40alienplatform/manager-api/#readme-alienplatformmanager-api)
    -   [SDK 安装](https://npmcn.com/package/%40alienplatform/manager-api/#readme-sdk-installation)
    -   [所需资源](https://npmcn.com/package/%40alienplatform/manager-api/#readme-requirements)
    -   [SDK 示例使用法](https://npmcn.com/package/%40alienplatform/manager-api/#readme-sdk-example-usage)
    -   [认证](https://npmcn.com/package/%40alienplatform/manager-api/#readme-authentication)
    -   [现有资源和业务](https://npmcn.com/package/%40alienplatform/manager-api/#readme-available-resources-and-operations)
    -   [独立职能](https://npmcn.com/package/%40alienplatform/manager-api/#readme-standalone-functions)
    -   [检索](https://npmcn.com/package/%40alienplatform/manager-api/#readme-retries)
    -   [处理错误](https://npmcn.com/package/%40alienplatform/manager-api/#readme-error-handling)
    -   [自定义 HTTP 客户端](https://npmcn.com/package/%40alienplatform/manager-api/#readme-custom-http-client)
    -   [调试](https://npmcn.com/package/%40alienplatform/manager-api/#readme-debugging)
-   [发展](https://npmcn.com/package/%40alienplatform/manager-api/#readme-development)
    -   [成熟度](https://npmcn.com/package/%40alienplatform/manager-api/#readme-maturity)
    -   [捐款](https://npmcn.com/package/%40alienplatform/manager-api/#readme-contributions)

## SDK 安装

> \[TIP\] 要完成将您的 SDK 发布到 npm 和其他您必须 [运行您的第一代动作](https://www.speakeasy.com/docs/github-setup#step-by-step-guide)。 。 。 .

SDK可以安装其中之一 [无](https://www.npmjs.com/), (中文(简体) ), [小时](https://pnpm.io/), (中文(简体) ), [包头](https://bun.sh/) 或者说 [线条](https://classic.yarnpkg.com/en/) 软件包管理器.

### 国家预防机制

```bash
npm add <UNSET>
```

### 菲律宾

```bash
pnpm add <UNSET>
```

### 阿宝

```bash
bun add <UNSET>
```

### 雅伦

```bash
yarn add <UNSET>
```

> \[注\] 此软件包仅作为ES模块(ESM)发布. 用于应用 常见JS, 使用 `await import()` 以导入和使用此软件包.

## 所需资源

对于支持的 JavaScript 运行时间, 请参考 [运行时间.md](https://npmcn.com/package/%40alienplatform/manager-api/RUNTIMES.md)。 。 。 .

## SDK 示例使用法

### 示例

```typescript
import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

```

## 认证

### 常客安全计划

这个SDK在全球支持以下安全计划:

| 名称 | 类型 | 计划 | 环境变量 |
| --- | --- | --- | --- |
| `bearer` | 网页 | HTTP 缓冲器 | `ALIEN_MANAGER_BEARER` |

用 API 认证 `bearer` 初始化 SDK 客户端实例时必须设置参数 。 例如:

```typescript
import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

```

## 现有资源和业务

可用方法

### [约束](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/bindings/README.md)

-   [解析边框](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/bindings/README.md#resolvebinding)

### [图标](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md)

-   [创建命令](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#createcommand) - 创建一个新的命令
-   [获取命令状态](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#getcommandstatus) - 获取命令状态
-   [获得命令/ 打印](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#getcommandpayload) - 从KV获得指令有效载荷(参数和响应)
-   [存储命令](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#storecommandpayload) - 将命令有效载荷数据(参数和/或反应)直接储存到KV中.
-   [提交回复](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#submitresponse) - 提交部署后的答复
-   [上传完成](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#uploadcomplete) - 将上传标为完整

### [部署小组](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md)

-   [列表 部署组](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#listdeploymentgroups)
-   [创建部署组](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#createdeploymentgroup) - 这个文件中的每个处理器都会运行 `auth::require_auth(&state, &headers)` 然后线程 `&subject` 输入 `DeploymentStore` 电话——见 特征文件`DeploymentStore`供会议使用.
-   [获得部署组](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#getdeploymentgroup)
-   [创建部署组](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#createdeploymentgrouptoken)

### [部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md)

-   [列表 调动](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#listdeployments)
-   [创建部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#createdeployment) - 这个文件中的每个处理器都会运行 `auth::require_auth(&state, &headers)` 然后线程 `&subject` 输入 `DeploymentStore` 打电话 嵌入器 上游 API 的代理可以使用主题 `bearer_token` 页:1 过关;单租房的冲动忽略了它. 看医生的特质 \[`DeploymentStore`完全的公约.
-   [获得部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeployment)
-   [签名部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#signdeploymentbundle)
-   [获得部署源](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentbundlesources)
-   [部署频道](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setdeploymentchannel)
-   [删除部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#deletedeployment)
-   [获得部署信息](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentinfo)
-   [获得部署日志](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentlogs)
-   [部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setdeploymentpin)
-   [设置配额警告 覆盖](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setquotawarningoverrides) - 只保存设置;重试失败的部署仍然是明确的操作.
-   [调动](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#redeploy)
-   [重试](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#retrydeployment)
-   [获得部署](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentrouting)
-   [导入部署状态](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#importdeploymentstatus)
-   [获得部署目标](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymenttarget)

### [卫生](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/health/README.md)

-   [卫生](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/health/README.md#health)

### [租赁](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/leases/README.md)

-   [租赁](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/leases/README.md#acquireleases) - 获得投票部署租约
-   [租赁](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/leases/README.md#releaselease) - 发放租约

### [经理](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/manager/README.md)

-   [管理器信息](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/manager/README.md#managerinfo)

### [释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md)

-   [列表 管理器释放频道](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#listmanagerreleasechannels)
-   [创建管理器释放频道](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#createmanagerreleasechannel)
-   [删除管理器释放频道](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#deletemanagerreleasechannel)
-   [列表发布](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#listreleases) - 说吧 `GET /v1/releases` - 输入:工作空间/项目负责人(或认证) 用户)。 出站:呼叫者无记名(通过). 返回仅释放 呼叫者可以阅读.
-   [创建释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#createrelease)
-   [获取 Latest 释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#getlatestrelease)
-   [获取释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#getrelease)
-   [推动管理者释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#promotemanagerrelease)

### [堆栈导入](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/stackimport/README.md)

-   [堆栈导入](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/stackimport/README.md#stackimport) - 说吧 `POST /v1/stack/import` ——入驻:部署组载人.

### [同步](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md)

-   [初始化](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#initialize) - 说吧 `POST /v1/initialize` - 入境:部署小组无人员(典型), 或工作空间持有人,负责自办操作员的工作流程。 新部署 创建通过 `DeploymentStore::create_deployment(caller, …)` 这样 嵌入到上游 API 的代理服务器将行写入 dg 中 工作空间 不是经理的.
-   [代理同步](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#agentsync) - 说吧 `POST /v1/sync` ——入驻:部署随从. 代理驱动同步 路径; `caller: &Subject` 被线接入商店 所以嵌入者看到 特工自己的范围.
-   [获取](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#acquire) - 说吧 `POST /v1/sync/acquire` - 进入:工作空间/ dg/部署人员. `caller: &Subject` 被串入 `DeploymentStore::acquire` 这样 嵌入器可以授权与入境的呼叫者范围相对.
-   [对齐](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#reconcile) - 说吧 `POST /v1/sync/reconcile` 进入:工作空间/ dg/部署 无名氏. `caller: &Subject` 被串入 `DeploymentStore::reconcile`。 。 。 .
-   [释放](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#release) - 说吧 `POST /v1/sync/release` - 进入:工作空间/ dg/部署人员. `caller: &Subject` 被串入 `DeploymentStore::release`。 。 。 .
-   [更新](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#renew) - 延长购置的部署租约,不写部署状态.

### [键](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md)

-   [列表脚本](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#listtokens)
-   [创建托肯](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#createtoken) - 说吧 `POST /v1/tokens` ——创建范围标志(仅限管理员).
-   [删除脚本](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#deletetoken)

### [默认](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md)

-   [获取保密](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#getsecret)
-   [设置](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#setsecret)
-   [删除密钥](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#deletesecret)

### [呜](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/whoami/README.md)

-   [华美](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/whoami/README.md#whoami)

## 独立职能

上述所有方法都作为独立功能提供。 这些 函数是用于在浏览器中运行的应用程序的理想功能,没有服务器 运行时间或应用程序捆绑大小为主的其他环境 关心。 当使用捆绑器构建您的应用程序时, 全部未使用 功能将被从最后的捆绑中排除,或者被树切除.

要了解更多独立函数, 请检查 [职能.md](https://npmcn.com/package/%40alienplatform/manager-api/FUNCTIONS.md)。 。 。 .

现有的独立职能

-   [`bindingsResolveBinding`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/bindings/README.md#resolvebinding)
-   [`commandsCreateCommand`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#createcommand) - 创建一个新的命令
-   [`commandsGetCommandPayload`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#getcommandpayload) - 从KV获得指令有效载荷(参数和响应)
-   [`commandsGetCommandStatus`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#getcommandstatus) - 获取命令状态
-   [`commandsStoreCommandPayload`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#storecommandpayload) - 将命令有效载荷数据(参数和/或反应)直接储存到KV中.
-   [`commandsSubmitResponse`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#submitresponse) - 提交部署后的答复
-   [`commandsUploadComplete`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/commands/README.md#uploadcomplete) - 将上传标为完整
-   [`deploymentGroupsCreateDeploymentGroup`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#createdeploymentgroup) - 这个文件中的每个处理器都会运行 `auth::require_auth(&state, &headers)` 然后线程 `&subject` 输入 `DeploymentStore` 电话——见 特征文件`DeploymentStore`供会议使用.
-   [`deploymentGroupsCreateDeploymentGroupToken`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#createdeploymentgrouptoken)
-   [`deploymentGroupsGetDeploymentGroup`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#getdeploymentgroup)
-   [`deploymentGroupsListDeploymentGroups`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deploymentgroups/README.md#listdeploymentgroups)
-   [`deploymentsCreateDeployment`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#createdeployment) - 这个文件中的每个处理器都会运行 `auth::require_auth(&state, &headers)` 然后线程 `&subject` 输入 `DeploymentStore` 打电话 嵌入器 上游 API 的代理可以使用主题 `bearer_token` 页:1 过关;单租房的冲动忽略了它. 看医生的特质 \[`DeploymentStore`完全的公约.
-   [`deploymentsDeleteDeployment`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#deletedeployment)
-   [`deploymentsGetDeployment`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeployment)
-   [`deploymentsGetDeploymentBundleSources`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentbundlesources)
-   [`deploymentsGetDeploymentInfo`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentinfo)
-   [`deploymentsGetDeploymentLogs`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentlogs)
-   [`deploymentsGetDeploymentRouting`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymentrouting)
-   [`deploymentsGetDeploymentTarget`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#getdeploymenttarget)
-   [`deploymentsImportDeploymentStatus`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#importdeploymentstatus)
-   [`deploymentsListDeployments`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#listdeployments)
-   [`deploymentsRedeploy`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#redeploy)
-   [`deploymentsRetryDeployment`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#retrydeployment)
-   [`deploymentsSetDeploymentChannel`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setdeploymentchannel)
-   [`deploymentsSetDeploymentPin`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setdeploymentpin)
-   [`deploymentsSetQuotaWarningOverrides`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#setquotawarningoverrides) - 只保存设置;重试失败的部署仍然是明确的操作.
-   [`deploymentsSignDeploymentBundle`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/deployments/README.md#signdeploymentbundle)
-   [`healthHealth`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/health/README.md#health)
-   [`leasesAcquireLeases`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/leases/README.md#acquireleases) - 获得投票部署租约
-   [`leasesReleaseLease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/leases/README.md#releaselease) - 发放租约
-   [`managerManagerInfo`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/manager/README.md#managerinfo)
-   [`releasesCreateManagerReleaseChannel`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#createmanagerreleasechannel)
-   [`releasesCreateRelease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#createrelease)
-   [`releasesDeleteManagerReleaseChannel`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#deletemanagerreleasechannel)
-   [`releasesGetLatestRelease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#getlatestrelease)
-   [`releasesGetRelease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#getrelease)
-   [`releasesListManagerReleaseChannels`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#listmanagerreleasechannels)
-   [`releasesListReleases`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#listreleases) - 说吧 `GET /v1/releases` - 输入:工作空间/项目负责人(或认证) 用户)。 出站:呼叫者无记名(通过). 返回仅释放 呼叫者可以阅读.
-   [`releasesPromoteManagerRelease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/releases/README.md#promotemanagerrelease)
-   [`stackImportStackImport`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/stackimport/README.md#stackimport) - 说吧 `POST /v1/stack/import` ——入驻:部署组载人.
-   [`syncAcquire`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#acquire) - 说吧 `POST /v1/sync/acquire` - 进入:工作空间/ dg/部署人员. `caller: &Subject` 被串入 `DeploymentStore::acquire` 这样 嵌入器可以授权与入境的呼叫者范围相对.
-   [`syncAgentSync`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#agentsync) - 说吧 `POST /v1/sync` ——入驻:部署随从. 代理驱动同步 路径; `caller: &Subject` 被线接入商店 所以嵌入者看到 特工自己的范围.
-   [`syncInitialize`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#initialize) - 说吧 `POST /v1/initialize` - 入境:部署小组无人员(典型), 或工作空间持有人,负责自办操作员的工作流程。 新部署 创建通过 `DeploymentStore::create_deployment(caller, …)` 这样 嵌入到上游 API 的代理服务器将行写入 dg 中 工作空间 不是经理的.
-   [`syncReconcile`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#reconcile) - 说吧 `POST /v1/sync/reconcile` 进入:工作空间/ dg/部署 无名氏. `caller: &Subject` 被串入 `DeploymentStore::reconcile`。 。 。 .
-   [`syncRelease`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#release) - 说吧 `POST /v1/sync/release` - 进入:工作空间/ dg/部署人员. `caller: &Subject` 被串入 `DeploymentStore::release`。 。 。 .
-   [`syncRenew`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/sync/README.md#renew) - 延长购置的部署租约,不写部署状态.
-   [`tokensCreateToken`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#createtoken) - 说吧 `POST /v1/tokens` ——创建范围标志(仅限管理员).
-   [`tokensDeleteToken`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#deletetoken)
-   [`tokensListTokens`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/tokens/README.md#listtokens)
-   [`vaultDeleteSecret`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#deletesecret)
-   [`vaultGetSecret`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#getsecret)
-   [`vaultSetSecret`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/vault/README.md#setsecret)
-   [`whoamiWhoami`](https://npmcn.com/package/%40alienplatform/manager-api/docs/sdks/whoami/README.md#whoami)

## 检索

此 SDK 中的一些端点支持重试. 如果在没有任何配置的情况下使用SDK,则会回落到API提供的默认重试策略. 然而,默认的重试策略可以在一次操作的基础上被推翻,或者在整个SDK中被推翻.

更改单个 API 调用默认重试策略, 只需为调用提供重试 Config 对象 :

```typescript
import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

```

如果您想要覆盖所有支持重试的操作的默认重试策略, 您可以在 SDK 初始化时提供重试Config :

```typescript
import { AlienManager } from "@alienplatform/manager-api";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  const result = await alienManager.health.health();

  console.log(result);
}

run();

```

## 处理错误

[`AlienManagerError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/alienmanagererror.ts) 是所有 HTTP 错误响应的基础类。 其属性如下:

| 财产 | 类型 | 说明 |
| --- | --- | --- |
| `error.message` | `string` | 错误消息 |
| `error.statusCode` | `number` | HTTP 响应状态代码 eg `404` |
| `error.headers` | `Headers` | HTTP 响应头 |
| `error.body` | `string` | HTTP 躯体. 如果没有尸体返回, 则可以是空字符串 . |
| `error.rawResponse` | `Response` | 原始 HTTP 响应 |
| `error.data$` |  | 可选的 一些错误可能包含结构化数据. [参见错误类](https://npmcn.com/package/%40alienplatform/manager-api/#readme-error-classes)。 。 。 . |

### 示例

```typescript
import { AlienManager } from "@alienplatform/manager-api";
import * as errors from "@alienplatform/manager-api/models/errors";

const alienManager = new AlienManager({
  serverURL: "https://api.example.com",
  bearer: process.env["ALIEN_MANAGER_BEARER"] ?? "",
});

async function run() {
  try {
    const result = await alienManager.bindings.resolveBinding({
      deploymentId: "<id>",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AlienManagerError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.AlienError) {
        console.log(error.data$.code); // string
        console.log(error.data$.context); // any
        console.log(error.data$.hint); // string
        console.log(error.data$.httpStatusCode); // number
        console.log(error.data$.internal); // boolean
      }
    }
  }
}

run();

```

### 错误分类

**主错误 :**

-   [`AlienManagerError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/alienmanagererror.ts): HTTP 错误响应的基础类.

少常见错误(8)  

**网络错误 :**

-   [`ConnectionError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/httpclienterrors.ts): HTTP 客户端无法向服务器提出请求.
-   [`RequestTimeoutError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/httpclienterrors.ts): HTTP 请求由于中止信号而超时.
-   [`RequestAbortedError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/httpclienterrors.ts):HTTP请求被客户端中止.
-   [`InvalidRequestError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/httpclienterrors.ts): 用于创建请求的任何输入无效.
-   [`UnexpectedClientError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/httpclienterrors.ts):无法识别或出乎意料的错误.

**继承从 [`AlienManagerError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/alienmanagererror.ts)**数字 :

-   [`ErrorResponse`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/errorresponse.ts): API端点错误响应包. 适用于53个方法中的8个
-   [`AlienError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/alienerror.ts): Canonical 错误容器,它提供了一种结构化的方法来用丰富的元数据来表示错误,包括错误代码,人可读信息,上下文,以及用于错误传播的链路能力. 这种结构设计既可机器读取又便于用户使用,支持API响应的序列化和分布式系统中的详细错误报告. 适用于53个方法中的2个
-   [`ResponseValidationError`](https://npmcn.com/package/%40alienplatform/manager-api/src/models/errors/responsevalidationerror.ts):从服务器返回的数据和SDK期望的结构之间的类型不匹配. 见 `error.rawValue` 原值和 `error.pretty()` 用于格式化良好的多行字符串.

\* 检查 [方法文档](https://npmcn.com/package/%40alienplatform/manager-api/#readme-available-resources-and-operations) 以查看该错误是否适用.

## 自定义 HTTP 客户端

TypeScript SDK 使用一个 `HTTPClient` 将本地人包裹起来 [获取 API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)这个 客户端是薄薄的包装 `fetch` 并且提供连接钩子的能力 围绕可用于修改请求或处理的请求生命周期 错误和反应.

这个 `HTTPClient` 构造器使用可选 `fetcher` 参数可以是 用于整合第三方 HTTP 客户端或用于编写测试以嘲弄 hTTP 客户端并输入固定设备.

以下示例说明如何使用 `"beforeRequest"` 要添加的钩子 自定义标题和请求的超时及如何使用 `"requestError"` 钩子 记录错误 :

```typescript
import { AlienManager } from "@alienplatform/manager-api";
import { HTTPClient } from "@alienplatform/manager-api/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new AlienManager({ httpClient: httpClient });
```

## 调试

您可以为 SDK 请求和响应设置 SDK 以发送调试日志 .

你可以通过一个匹配的日志 `console`'作为 SDK 选项的接口.

> \[尖叫声\] 注意调试日志会揭示一些秘密, 如标题中的 API 令牌, 打印到控制台或文件中的日志信息 。 建议只在本地开发期间使用这一特征,而不能用于生产.

```typescript
import { AlienManager } from "@alienplatform/manager-api";

const sdk = new AlienManager({ debugLogger: console });
```

通过设置环境变量也可以启用默认调试日志 `ALIEN_MANAGER_DEBUG` 真实的.

# 发展

## 成熟度

这个SDK是在β中,在版本之间可能会有断裂的更改,而没有主要的版本更新. 因此,我们建议使用 到特定软件包版本。 这样,您可以每次安装同一版本而不中断更改,除非您是故意的 正在寻找最新版本.

## 捐款

虽然我们重视对SDK的开源贡献,但这个库是程序生成的. 任何加入内部文件的手动修改都会被覆盖到下一代上. 我们期待着听到你的反馈。 随便你开个公关 或一个有概念证明的问题 我们会尽力把它纳入未来的发行.

### SDK 创建者 [说话方便](https://www.speakeasy.com/?utm_source=@alienplatform/manager-api&utm_campaign=typescript)

## 常见问题

### @alienplatform/manager-api 是什么？

开发者友好型和型号安全型 SDK 专门适应杠杆 @alienplaft/manager-api \(英语\) API \(英语\)\.

### 如何安装 @alienplatform/manager-api？

在项目目录运行 npm install @alienplatform/manager-api，或使用 pnpm add / yarn add / bun add。

### @alienplatform/manager-api 支持 TypeScript 吗？

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

### @alienplatform/manager-api 支持 ESM 还是 CommonJS？

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

### @alienplatform/manager-api 可以商用吗？

@alienplatform/manager-api 使用 FSL-1\.1-Apache-2\.0 许可。声明的许可为 FSL-1\.1-Apache-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @alienplatform/manager-api 的下载量有多少？

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

### @alienplatform/manager-api 还在维护吗？

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