# @cumulus/api-client 中文文档

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

版本：22\.5\.0
npm 元数据更新时间：2026-11-05T21:00:12.923Z
中文译文更新时间：2026-11-11T05:45:31.858Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cumulus/api-client
原文对照：https://npmcn.com/package/%40cumulus/api-client/?lang=original
项目主页：https://github.com/nasa/cumulus/tree/master/packages/api-client#readme
源码仓库：https://github.com/nasa/cumulus

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

- 包体积（解压后）：997 kB，86 个文件
- TypeScript 类型：包内自带
- Node.js 要求：^22\.23\.4
- 运行依赖：4 个
- 首次发布：2020-03-05T23:51:49.834Z
- 最新版本发布：2026-11-05T21:00:12.728Z
- 近 30 天下载量：3142（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：180（近 12 个月 35 个）

## 中文简介

API 客户端用于 Cumulus 存档 API

## 安装

```sh
npm install @cumulus/api-client
```

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

## README

# @ cumulus/ api- 客户端

本模块提供功能,方便程序访问 Cumulus API 进行处理功能和集成测试. 这些方法使用“私人”内部API lambda,它使用与“公共”API Gateway相同的基本代码.

## 使用量

该模块的各种出口为Cumulus API提供常见电话的包装。 默认他们正在使用 提供的 `cumulusApiClient.invokeApi` 方法作为回调,但向所有方法构建一个选项,以提供替代/被包装的版本(例如用于验证).

```bash
npm install @cumulus/api-client
```

### 示例

```javascript
const { granules } = require('@cumulus/api-client');

const granule = await granules.getGranule({
  prefix: process.env.STACKNAME,
  granuleId,
  collectionId
});
```

以上示例调用将返回API(例如. `JSON.parse(response.body)`) (中文(简体) ).

## 关于 Cumulus

Cumulus是美国航天局未来地球科学数据流的以云为基础的数据摄取,存档,分发和管理原型.

[Cumulus 文档](https://nasa.github.io/cumulus)

## 捐款

做贡献,请 [参见我们的贡献准则](https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md)。 。 。 .

## 常见问题

### @cumulus/api-client 是什么？

API 客户端用于 Cumulus 存档 API

### 如何安装 @cumulus/api-client？

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

### @cumulus/api-client 支持 TypeScript 吗？

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

### @cumulus/api-client 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.23\.4。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cumulus/api-client 可以商用吗？

@cumulus/api-client 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cumulus/api-client 的下载量有多少？

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

### @cumulus/api-client 还在维护吗？

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