@aws-sdk/client-storage-gateway

中文文档
3.1164.0发布于 2026/11/07Apache-2.0TypeScriptESM + CJS近 30 天下载 12.4万

JavaScript 存储网关客户端的 AWS SDK , 用于 Node.js, 浏览器和 React Introduct

中文使用文档
文档目录10 节
  1. 说明
  2. 安装
  3. 开始
  4. 导入
  5. 使用量
  6. 解决问题
  7. 获取帮助
  8. 捐款
  9. 许可证
  10. 客户端命令( 操作列表)

@aws-sdk/ 客户端- 存储- 出入口

说明

JavaScript存储Gateway客户端的 AWS SDK 为Node.js, 浏览器和React Industrial.

存储网关服务

亚马逊FSx文件网关不再供新客户使用. 现有 fSx文件网关的客户可以继续正常使用该服务. 对于 类似于 FSx 文件网关、访问 这个博客文章。 。 。 .

存储网关(Survey Gateway)是连接一个基于前提的软件应用程序的服务 与以云为基础的存储提供无缝和安全的集成 亚马逊网络服务存储 基础设施。 该服务使您能够安全地将数据上传到亚马逊网络服务云,以进行成本效益高的备份和快速的灾后恢复.

使用下列链接开始使用 存储网关 服务 API 参考数字 :

  • 需要请求头的存储网关: 说明所需的 您必须随 POST 请求一起发送到存储网关的头条 .

  • 签名请求: 存储网关需要您认证 您发送的每个请求; 此话题描述如何签名此请求 .

  • 错误答复:提供存储网关错误的参考信息.

  • 存储网关中的操作: 包含所有存储网关操作的详细说明,其请求参数,响应要素,可能出错,以及 请求和答复的例子.

  • 存储网关 终点和配额: 提供每个亚马逊网络服务区域的列表 和可用存储网关的终点.

存储网关资源ID为大写. 当你使用这些资源ID时 与 Amazon EC2 API, EC2 在小写中期望资源ID. 你必须改变 使用 EC2 API 来使用。 例如,在存储中 网关ID的音量可能是 vol-AA22BB012345DAF670当您使用时 此ID与 EC2 API, 您必须更改为 vol-aa22bb012345daf670。 。 。 . 否则,EC2 API的行为可能不如预期.

从网关创建的存储网关卷和亚马逊 EBS快照的ID 卷正在改为更长的格式。 从2016年12月开始,所有新卷和 将使用17个字符串创建快照 。 从2016年4月开始,你会 能够使用这些较长的ID,以便用新格式测试您的系统。 对于 更多信息,见 延长EC2和 EBS 资源标识。 。 。 .

例如,一个带有更长的卷式ID格式的卷式Amazon资源名(ARN) 外观如下:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG。 。 。 .

使用更长的ID格式的快照ID外观如下: snap-78e226633445566ee。 。 。 .

更多信息见 通知: 提醒 – 更长的存储网关量和快照 ID 输入 2016 (英语)。 。 。 .

安装

要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :

  • npm install @aws-sdk/client-storage-gateway
  • yarn add @aws-sdk/client-storage-gateway
  • pnpm add @aws-sdk/client-storage-gateway

开始

导入

AWS SDK由客户端和命令进行调制. 要发送请求,只需导入 StorageGatewayClient 财务报告和审定财务报表 例如,您需要的命令 ListTapesCommand数字 :

// ES5 example
const { StorageGatewayClient, ListTapesCommand } = require("@aws-sdk/client-storage-gateway");
// ES6+ example
import { StorageGatewayClient, ListTapesCommand } from "@aws-sdk/client-storage-gateway";

使用量

发出请求:

  • 以配置(如证书,区域)为客户端提供证据.
  • 以输入参数证明命令 .
  • 打电话 send 操作客户端,以输入方式提供命令对象.
const client = new StorageGatewayClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListTapesCommand(params);

自动/等待

我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

承诺

您还可以使用 承诺连锁。 。 。 .

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

合并客户端

归集客户端类别从同套件中导出,但没有"Client"后缀.

StorageGateway 扩展 StorageGatewayClient 并额外支持所有操作,服务员, 和活人作为方法. 这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(StorageGatewayClient) (中文(简体) ). 更多详情见博客文章: javaScript 的 AWS SDK 模块包。 。 。 .

import { StorageGateway } from "@aws-sdk/client-storage-gateway";

const client = new StorageGateway({ region: "REGION" });

// async/await.
try {
  const data = await client.listTapes(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTapes(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listTapes(params, (err, data) => {
  // process err and data.
});

解决问题

当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

另见 文档/错误。 。 。 .

获取帮助

请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .

捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-storage-gateway 软件包正在更新. 为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .

许可证

此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.

客户端命令( 操作列表)

激活 Gateway 系统

命令 API 引用 编号 : 投入 编号 : 产出

添加缓存

命令 API 引用 编号 : 投入 编号 : 产出

添加 Tags 资源

命令 API 引用 编号 : 投入 编号 : 产出

添加负载缓冲

命令 API 引用 编号 : 投入 编号 : 产出

添加工作集

命令 API 引用 编号 : 投入 编号 : 产出

指定塔皮波尔

命令 API 引用 编号 : 投入 编号 : 产出

关联系统

命令 API 引用 编号 : 投入 编号 : 产出

随附卷

命令 API 引用 编号 : 投入 编号 : 产出

取消档案

命令 API 引用 编号 : 投入 编号 : 产出

取消缓存报告

命令 API 引用 编号 : 投入 编号 : 产出

取消检索

命令 API 引用 编号 : 投入 编号 : 产出

创建 CachediSCSI 卷

命令 API 引用 编号 : 投入 编号 : 产出

创建 NFSFile 共享

命令 API 引用 编号 : 投入 编号 : 产出

创建 SMBFile 共享

命令 API 引用 编号 : 投入 编号 : 产出

创建抓图

命令 API 引用 编号 : 投入 编号 : 产出

从Volume Recovery Point 创建图像

命令 API 引用 编号 : 投入 编号 : 产出

创建 StorediSCSI 卷

命令 API 引用 编号 : 投入 编号 : 产出

创建 TapePool

命令 API 引用 编号 : 投入 编号 : 产出

创建标签

命令 API 引用 编号 : 投入 编号 : 产出

创建带条码的标签

命令 API 引用 编号 : 投入 编号 : 产出

删除自动创建策略

命令 API 引用 编号 : 投入 编号 : 产出

删除 Bandwidth RateLimit

命令 API 引用 编号 : 投入 编号 : 产出

删除缓存报告

命令 API 引用 编号 : 投入 编号 : 产出

删除章节

命令 API 引用 编号 : 投入 编号 : 产出

删除文件共享

命令 API 引用 编号 : 投入 编号 : 产出

删除Gateway

命令 API 引用 编号 : 投入 编号 : 产出

删除缩略图列表

命令 API 引用 编号 : 投入 编号 : 产出

删除标签

命令 API 引用 编号 : 投入 编号 : 产出

删除塔佩箭头

命令 API 引用 编号 : 投入 编号 : 产出

删除 TapePool

命令 API 引用 编号 : 投入 编号 : 产出

删除卷

命令 API 引用 编号 : 投入 编号 : 产出

描述可操作性监测试验

命令 API 引用 编号 : 投入 编号 : 产出

描述 Bandwidth RateLimit 语句

命令 API 引用 编号 : 投入 编号 : 产出

描述 Bandwidth RateLimit 附表

命令 API 引用 编号 : 投入 编号 : 产出

描述缓存

命令 API 引用 编号 : 投入 编号 : 产出

描述 CachediSCSI 卷

命令 API 引用 编号 : 投入 编号 : 产出

描述缓存报告

命令 API 引用 编号 : 投入 编号 : 产出

描述章序文

命令 API 引用 编号 : 投入 编号 : 产出

描述系统协会

命令 API 引用 编号 : 投入 编号 : 产出

描述 Gateway 信息

命令 API 引用 编号 : 投入 编号 : 产出

描述维护开始时间

命令 API 引用 编号 : 投入 编号 : 产出

描述 NFSFile 共享

命令 API 引用 编号 : 投入 编号 : 产出

描述 SMBFile 共享

命令 API 引用 编号 : 投入 编号 : 产出

描述SMBSetting

命令 API 引用 编号 : 投入 编号 : 产出

描述截图列表

命令 API 引用 编号 : 投入 编号 : 产出

描述 StorediSCSI 卷

命令 API 引用 编号 : 投入 编号 : 产出

描述塔佩箭头

命令 API 引用 编号 : 投入 编号 : 产出

描述标签回收点

命令 API 引用 编号 : 投入 编号 : 产出

描述标签

命令 API 引用 编号 : 投入 编号 : 产出

描述卸载缓冲

命令 API 引用 编号 : 投入 编号 : 产出

描述 VTL 设备

命令 API 引用 编号 : 投入 编号 : 产出

描述工作集

命令 API 引用 编号 : 投入 编号 : 产出

调试卷

命令 API 引用 编号 : 投入 编号 : 产出

禁用 Gateway 系统

命令 API 引用 编号 : 投入 编号 : 产出

脱离关联系统

命令 API 引用 编号 : 投入 编号 : 产出

Evict Files Faing 上载

命令 API 引用 编号 : 投入 编号 : 产出

连接域

命令 API 引用 编号 : 投入 编号 : 产出

自动创建策略

命令 API 引用 编号 : 投入 编号 : 产出

列表缓存报告

命令 API 引用 编号 : 投入 编号 : 产出

列表文件共享

命令 API 引用 编号 : 投入 编号 : 产出

列表系统协会

命令 API 引用 编号 : 投入 编号 : 产出

列表通道

命令 API 引用 编号 : 投入 编号 : 产出

列表本地磁盘

命令 API 引用 编号 : 投入 编号 : 产出

列表标签格式资源

命令 API 引用 编号 : 投入 编号 : 产出

列表标签

命令 API 引用 编号 : 投入 编号 : 产出

列表标签

命令 API 引用 编号 : 投入 编号 : 产出

清单

命令 API 引用 编号 : 投入 编号 : 产出

ListVolume 恢复点

命令 API 引用 编号 : 投入 编号 : 产出

列表卷

命令 API 引用 编号 : 投入 编号 : 产出

通知 装入时

命令 API 引用 编号 : 投入 编号 : 产出

刷新缓存

命令 API 引用 编号 : 投入 编号 : 产出

从资源中删除标签

命令 API 引用 编号 : 投入 编号 : 产出

重置缓存

命令 API 引用 编号 : 投入 编号 : 产出

获取塔佩箭头

命令 API 引用 编号 : 投入 编号 : 产出

获取 Tape 回收点

命令 API 引用 编号 : 投入 编号 : 产出

设置本地控件Password

命令 API 引用 编号 : 投入 编号 : 产出

设置SMB 客户名词

命令 API 引用 编号 : 投入 编号 : 产出

关闭Gateway

命令 API 引用 编号 : 投入 编号 : 产出

启动可用性检测

命令 API 引用 编号 : 投入 编号 : 产出

启动缓存报告

命令 API 引用 编号 : 投入 编号 : 产出

开始 Gateway

命令 API 引用 编号 : 投入 编号 : 产出

更新自动创建策略

命令 API 引用 编号 : 投入 编号 : 产出

更新 Bandwidth RateLimit

命令 API 引用 编号 : 投入 编号 : 产出

更新 BandwidthRateLimit 附表

命令 API 引用 编号 : 投入 编号 : 产出

更新章证

命令 API 引用 编号 : 投入 编号 : 产出

更新文件系统协会

命令 API 引用 编号 : 投入 编号 : 产出

更新 Gateway 信息

命令 API 引用 编号 : 投入 编号 : 产出

更新 GatewaySoftware 现在

命令 API 引用 编号 : 投入 编号 : 产出

更新维护起始时间

命令 API 引用 编号 : 投入 编号 : 产出

更新 NFSFile 共享

命令 API 引用 编号 : 投入 编号 : 产出

更新 SMBBile 共享

命令 API 引用 编号 : 投入 编号 : 产出

更新SMBFile 共享可视性

命令 API 引用 编号 : 投入 编号 : 产出

更新SMB 本地组

命令 API 引用 编号 : 投入 编号 : 产出

更新SMB安全战略

命令 API 引用 编号 : 投入 编号 : 产出

更新Snapshot时间表

命令 API 引用 编号 : 投入 编号 : 产出

更新 VTL 服务器Type

命令 API 引用 编号 : 投入 编号 : 产出

版本与发布记录

@aws-sdk/client-storage-gateway 共发布 738 个版本,首次发布于 2020/01/08;过去 12 个月发布了 221 个版本。

版本发布日期距今
3.1164.0latest2026/11/07今天
3.1163.02026/11/061 天前
3.1162.02026/11/052 天前
3.1161.02026/10/318 天前
3.1160.02026/10/309 天前
3.1159.02026/10/2910 天前

其他发布通道:alpha → 1.0.0-alpha.26,beta → 1.0.0-beta.5,gamma → 1.0.0-gamma.11,rc → 3.5.1-rc.0。

关于 @aws-sdk/client-storage-gateway 的常见问题

@aws-sdk/client-storage-gateway 是什么?

JavaScript 存储网关客户端的 AWS SDK , 用于 Node.js, 浏览器和 React Introduct

如何安装 @aws-sdk/client-storage-gateway?

在项目目录运行 npm install @aws-sdk/client-storage-gateway,或使用 pnpm add / yarn add / bun add。

@aws-sdk/client-storage-gateway 支持 TypeScript 吗?

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

@aws-sdk/client-storage-gateway 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@aws-sdk/client-storage-gateway 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@aws-sdk/client-storage-gateway 可以商用吗?

@aws-sdk/client-storage-gateway 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@aws-sdk/client-storage-gateway 的下载量有多少?

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

@aws-sdk/client-storage-gateway 还在维护吗?

最新版本 3.1164.0 发布于 2026/11/07(今天);至今共发布 738 个版本,其中过去 12 个月发布了 221 个;首次发布于 2020/01/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。