# @aws-sdk/client-docdb 中文文档

规范地址：https://npmcn.com/package/%40aws-sdk/client-docdb/

版本：3\.1164\.0
npm 元数据更新时间：2026-11-06T20:16:50.219Z
中文译文更新时间：2026-11-07T10:39:28.737Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aws-sdk/client-docdb
原文对照：https://npmcn.com/package/%40aws-sdk/client-docdb/?lang=original
项目主页：https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-docdb
源码仓库：https://github.com/aws/aws-sdk-js-v3

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

- 包体积（解压后）：1.3 MB，292 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：9 个
- 首次发布：2020-01-17T03:16:13.706Z
- 最新版本发布：2026-11-06T20:16:50.062Z
- 近 30 天下载量：422603（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：732（近 12 个月 220 个）

## 中文简介

JavaScript Docdb 客户端 Node.js 的 AWS SDK, 浏览器和回放本地

## 安装

```sh
npm install @aws-sdk/client-docdb
```

也可以使用：`pnpm add @aws-sdk/client-docdb`、`yarn add @aws-sdk/client-docdb`、`bun add @aws-sdk/client-docdb`

## README

# @aws-sdk/客户端-docdb

## 说明

用于节点.js的JavaScript DocDB客户端的AWS SDK,浏览器和React Industrial.

Amazon DocumentDB是一个快速,可靠,管理完善的数据库服务. Amazon DocumentDB使得在云中建立,运行,并规模化相容的MongoDB数据库变得容易. 通过Amazon DocumentDB,您可以运行相同的应用程序代码,并使用与MongoDB相同的驱动器和工具.

## 安装

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

-   `npm install @aws-sdk/client-docdb`
-   `yarn add @aws-sdk/client-docdb`
-   `pnpm add @aws-sdk/client-docdb`

## 开始

### 导入

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

```js
// ES5 example
const { DocDBClient, ListTagsForResourceCommand } = require("@aws-sdk/client-docdb");
```

```ts
// ES6+ example
import { DocDBClient, ListTagsForResourceCommand } from "@aws-sdk/client-docdb";
```

### 使用量

发出请求:

-   以配置(如证书,区域)为客户端提供证据.
    -   见 [文件/中心](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) 用于配置细节.
    -   见 [@aws- sdk/ 配置](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) 附加选项.
-   以输入参数证明命令 .
-   打电话 `send` 操作客户端,以输入方式提供命令对象.

```js
const client = new DocDBClient({ region: "REGION" });

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

#### 自动/等待

我们建议使用 [等待时](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) 运算符等待通过发送操作返回的承诺如下:

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

#### 承诺

您还可以使用 [承诺连锁](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)。 。 。 .

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

#### 合并客户端

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

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

如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(`DocDBClient`) (中文(简体) ). 更多详情见博客文章: [javaScript 的 AWS SDK 模块包](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)。 。 。 .

```ts
import { DocDB } from "@aws-sdk/client-docdb";

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

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

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

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

### 解决问题

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

```js
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;
   * }
   */
}
```

另见 [文档/错误](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md)。 。 。 .

## 获取帮助

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

-   访问 [开发者指南](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) 或者说 [API 参考](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html)。 。 。 .
-   看看贴有标签的博客文章 [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) aWS 开发者博客.
-   问个问题 [叠叠流](https://stackoverflow.com/questions/tagged/aws-sdk-js) 并贴上标签 `aws-sdk-js`。 。 。 .
-   加入 AWS JavaScript 社区 [发光](https://gitter.im/aws/aws-sdk-js-v3)。 。 。 .
-   如果你发现你发现了一个虫子,请 [打开一个问题](https://github.com/aws/aws-sdk-js-v3/issues/new/choose)。 。 。 .

为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 [代码样本 repo](https://github.com/aws-samples/aws-sdk-js-tests)。 。 。 .

## 捐款

此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 `@aws-sdk/client-docdb` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients)。 。 。 .

## 许可证

此 SDK 分布于 [Apache 许可证,2.0版本](http://www.apache.org/licenses/LICENSE-2.0), (中文(简体) ), 更多信息见LICENSE.

## 客户端命令( 操作列表)

添加来源标识符到订阅

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/AddSourceIdentifierToSubscriptionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/AddSourceIdentifierToSubscriptionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/AddSourceIdentifierToSubscriptionCommandOutput/)

添加 Tags 资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/AddTagsToResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/AddTagsToResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/AddTagsToResourceCommandOutput/)

应用维护操作

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ApplyPendingMaintenanceActionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ApplyPendingMaintenanceActionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ApplyPendingMaintenanceActionCommandOutput/)

复制 DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CopyDBClusterParameterGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CopyDBClusterParameterGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CopyDBClusterParameterGroupCommandOutput/)

复制 DBCluster 截图

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CopyDBClusterSnapshotCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CopyDBClusterSnapshotCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CopyDBClusterSnapshotCommandOutput/)

创建 DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterCommandOutput/)

创建 DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateDBClusterParameterGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterParameterGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterParameterGroupCommandOutput/)

创建 DBCluster 缩写

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateDBClusterSnapshotCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterSnapshotCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBClusterSnapshotCommandOutput/)

创建 DB 投资

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateDBInstanceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBInstanceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBInstanceCommandOutput/)

创建 DBSubnet 组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateDBSubnetGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBSubnetGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateDBSubnetGroupCommandOutput/)

创建事件订阅

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateEventSubscriptionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateEventSubscriptionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateEventSubscriptionCommandOutput/)

创建全球组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/CreateGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/CreateGlobalClusterCommandOutput/)

删除 DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterCommandOutput/)

删除 DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteDBClusterParameterGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterParameterGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterParameterGroupCommandOutput/)

删除 DBCluster 截图

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteDBClusterSnapshotCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterSnapshotCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBClusterSnapshotCommandOutput/)

删除DBInstance

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteDBInstanceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBInstanceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBInstanceCommandOutput/)

删除 DB 子网组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteDBSubnetGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBSubnetGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteDBSubnetGroupCommandOutput/)

删除事件订阅

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteEventSubscriptionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteEventSubscriptionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteEventSubscriptionCommandOutput/)

删除全局分类

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DeleteGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DeleteGlobalClusterCommandOutput/)

描述证书

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeCertificatesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeCertificatesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeCertificatesCommandOutput/)

描述 DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBClusterParameterGroupsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterParameterGroupsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterParameterGroupsCommandOutput/)

描述 DBCluster 参数

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBClusterParametersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterParametersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterParametersCommandOutput/)

描述 DB 分类

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBClustersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClustersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClustersCommandOutput/)

描述 DBCluster 缩写属性

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBClusterSnapshotAttributesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterSnapshotAttributesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterSnapshotAttributesCommandOutput/)

描述 DBCluster 截图

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBClusterSnapshotsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterSnapshotsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBClusterSnapshotsCommandOutput/)

描述 DBEngine 参数

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBEngineVersionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBEngineVersionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBEngineVersionsCommandOutput/)

描述 DB 投资

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBInstancesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBInstancesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBInstancesCommandOutput/)

描述 DB 子网组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeDBSubnetGroupsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBSubnetGroupsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeDBSubnetGroupsCommandOutput/)

描述引擎断层组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeEngineDefaultClusterParametersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEngineDefaultClusterParametersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEngineDefaultClusterParametersCommandOutput/)

描述事件类别

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeEventCategoriesCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventCategoriesCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventCategoriesCommandOutput/)

描述事件

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeEventsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventsCommandOutput/)

描述事件订阅

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeEventSubscriptionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventSubscriptionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeEventSubscriptionsCommandOutput/)

描述全球分类

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeGlobalClustersCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeGlobalClustersCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeGlobalClustersCommandOutput/)

描述可命令的DBInstance选项

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeOrderableDBInstanceOptionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeOrderableDBInstanceOptionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeOrderableDBInstanceOptionsCommandOutput/)

描述维持活动

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribePendingMaintenanceActionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribePendingMaintenanceActionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribePendingMaintenanceActionsCommandOutput/)

描述ServerlessV2等式

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/DescribeServerlessV2PlatformVersionsCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeServerlessV2PlatformVersionsCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/DescribeServerlessV2PlatformVersionsCommandOutput/)

失败的DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/FailoverDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/FailoverDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/FailoverDBClusterCommandOutput/)

失败全球组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/FailoverGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/FailoverGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/FailoverGlobalClusterCommandOutput/)

列表标签格式资源

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ListTagsForResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ListTagsForResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ListTagsForResourceCommandOutput/)

修改 DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterCommandOutput/)

修改 DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyDBClusterParameterGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterParameterGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterParameterGroupCommandOutput/)

修改 DBCluster 缩写属性

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyDBClusterSnapshotAttributeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterSnapshotAttributeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBClusterSnapshotAttributeCommandOutput/)

修改DB稳定

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyDBInstanceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBInstanceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBInstanceCommandOutput/)

修改 DB 子网组

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyDBSubnetGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBSubnetGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyDBSubnetGroupCommandOutput/)

修改 Event 订阅

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyEventSubscriptionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyEventSubscriptionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyEventSubscriptionCommandOutput/)

修改全球分类

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ModifyGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ModifyGlobalClusterCommandOutput/)

重启DBInstance

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RebootDBInstanceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RebootDBInstanceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RebootDBInstanceCommandOutput/)

从 Global Cluster 删除

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RemoveFromGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveFromGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveFromGlobalClusterCommandOutput/)

从订阅中删除源代码

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RemoveSourceIdentifierFromSubscriptionCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveSourceIdentifierFromSubscriptionCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveSourceIdentifierFromSubscriptionCommandOutput/)

从资源中删除标签

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RemoveTagsFromResourceCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveTagsFromResourceCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RemoveTagsFromResourceCommandOutput/)

重置DBCluster 组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/ResetDBClusterParameterGroupCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ResetDBClusterParameterGroupCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/ResetDBClusterParameterGroupCommandOutput/)

从抓图恢复 DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RestoreDBClusterFromSnapshotCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RestoreDBClusterFromSnapshotCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RestoreDBClusterFromSnapshotCommandOutput/)

恢复 DBCluster 到点时间

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/RestoreDBClusterToPointInTimeCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RestoreDBClusterToPointInTimeCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/RestoreDBClusterToPointInTimeCommandOutput/)

开始DBCluster

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/StartDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/StartDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/StartDBClusterCommandOutput/)

停止 DBClus

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/StopDBClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/StopDBClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/StopDBClusterCommandOutput/)

切换全球组合

[命令 API 引用](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/docdb/command/SwitchoverGlobalClusterCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/SwitchoverGlobalClusterCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-docdb/Interface/SwitchoverGlobalClusterCommandOutput/)

## 常见问题

### @aws-sdk/client-docdb 是什么？

JavaScript Docdb 客户端 Node\.js 的 AWS SDK, 浏览器和回放本地

### 如何安装 @aws-sdk/client-docdb？

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

### @aws-sdk/client-docdb 支持 TypeScript 吗？

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

### @aws-sdk/client-docdb 支持 ESM 还是 CommonJS？

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

### @aws-sdk/client-docdb 需要什么版本的 Node\.js？

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

### @aws-sdk/client-docdb 可以商用吗？

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

### @aws-sdk/client-docdb 的下载量有多少？

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

### @aws-sdk/client-docdb 还在维护吗？

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

