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

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

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

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

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

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

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

## 中文简介

JavaScript Pi Clients for Node.js的 AWS SDK, 浏览器和回放原生

## 安装

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

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

## README

# @aws- sdk/ 客户端- pi

## 说明

JavaScript PI 客户端的 AWS SDK 为 Node.js , 浏览器和 React Introduct .

亚马逊 RDS 性能透视

Amazon RDS Performance Insights使您能够根据从运行中的 DB 实例中获取的数据来监测和探索数据库负载的不同维度. 指南 提供性能透视数据类型,参数和出错的详细信息.

当 Performance Insights 启用时, Amazon RDS Performance Insights API 为您的 DB 实例的性能提供能见度 。 亚马逊云表提供 亚马逊Web Services 服务的权威性源码监测度量衡. 性能透视(Performance Insights)提供了DB负载的专有域视图.

DB 负载被测量为平均活动会话. Performance Insights将数据作为二维时序数据集提供给API消费者. 时间维度 提供被询问时间范围内每个时间点的 DB 加载数据。 每个时间点根据请求分解总体负荷 维度,在那个时间点测量。 例子包括SQL,等闲会,用户和主机.

-   为了了解更多关于性能透视和亚马逊Aurora DB的例子,请前往 _[亚马逊-奥罗拉用户指南](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html)_ 。 。 。 .
    
-   要了解更多关于性能透视和亚马逊 RDS DB 实例,请前往 _[亚马逊 RDS 用户指南](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)_ 。 。 。 .
    
-   为了更多地了解性能透视和亚马逊文档DB集群,请前往 _[Amazon 文档DB 开发者指南](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html)_ 。 。 。 .
    

## 安装

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

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

## 开始

### 导入

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

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

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

### 使用量

发出请求:

-   以配置(如证书,区域)为客户端提供证据.
    -   见 [文件/中心](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 PIClient({ region: "REGION" });

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

#### 支持的信件协议

这个客户端支持多个协议.

此客户端的默认值是 **AWS JSON (RPC) 1.1**。 。 。 .

我们根据对 javaScript中此协议格式的性能特征. 你不需要改变它, 但您可以选择这样做,例如支持现有的整合或测试. 选择非默认协议更改格式 ,但不影响您如何与网络交互 使用 JavaScript 对象的客户端.

安装 `@aws-sdk/config` 软件包以访问其他协议.

见 [AWS 议定书](https://smithy.io/2.0/aws/protocols/index.html) 更多信息.

##### AWS JSON (RPC) 1.1

本协议使用JSON有效载荷.

```js
import { AwsJson1_1Protocol } from "@aws-sdk/config/protocol";

const client = new PIClient({
  protocol: AwsJson1_1Protocol
});
```

##### Smithy RPC v2 CBOR 游戏

本协议使用CBOR有效载荷.

```js
import { AwsSmithyRpcV2CborProtocol } from "@aws-sdk/config/protocol";

const client = new PIClient({
  protocol: AwsSmithyRpcV2CborProtocol
});
```

#### 自动/等待

我们建议使用 [等待时](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"后缀.

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

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

```ts
import { PI } from "@aws-sdk/client-pi";

const client = new PI({ 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-pi` 软件包正在更新. 为了帮助客户,你可以检查我们 [生成客户端脚本](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/pi/command/CreatePerformanceAnalysisReportCommand/) 编号 : [投入](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pi/Interface/CreatePerformanceAnalysisReportCommandInput/) 编号 : [产出](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-pi/Interface/CreatePerformanceAnalysisReportCommandOutput/)

删除绩效分析报告

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

描述二相键

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

获取 Dimension 关键细节

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

获取绩效分析报告

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

获取资源元数据

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

获取资源计量

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

ListAvailable 资源属性

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

ListAvailable 资源量表

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

清单绩效分析报告建议

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

清单绩效分析报告

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

列表标签格式资源

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

标签资源

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

调和资源

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

## 常见问题

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

JavaScript Pi Clients for Node\.js的 AWS SDK, 浏览器和回放原生

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

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

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

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

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

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

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

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

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

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

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

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

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

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