# 使用 Performance Insights API for Amazon RDS 检索指标
<a name="USER_PerfInsights.API"></a>

开启性能详情后，API 将提供实例性能的可见性。Amazon CloudWatch Logs 日志为Amazon服务提供售卖监控指标的权威源。

Performance Insights 提供了按平均活动会话 (AAS) 衡量的数据库负载的特定于域的视图。对 API 使用者而言，此指标看起来像是二维时间序列数据集。数据的时间维度提供所查询时间范围的每个时间点的数据库负载数据。每个时间点将分解与所请求维度相关的整体负载，如相应时间点测量的 `SQL`、`Wait-event`、`User` 或 `Host`。

Amazon RDS Performance Insights 用于监控您的 Amazon RDS 数据库实例，使您可以分析数据库性能和排查数据库性能问题。查看 Performance Insights 数据的一种方法是在 Amazon Web Services 管理控制台中。Performance Insights 还提供公有 API，以便您可以查询自己的数据。您可以使用 API 来执行以下操作：
+ 将数据卸载到数据库中
+ 将 Performance Insights 数据添加到现有监控控制面板
+ 构建监控工具

要使用 Performance Insights API，请在您的 Amazon RDS 数据库实例之一上启用 Performance Insights。有关启用 Performance Insights 的信息，请参阅 [为 Amazon RDS 打开和关闭性能详情](USER_PerfInsights.Enabling.md)。有关 Performance Insights API 的更多信息，请参阅 [Amazon RDS Performance Insights API 参考](https://docs.amazonaws.cn/performance-insights/latest/APIReference/Welcome.html)。

Performance Insights API 提供以下操作。


****  

|  Performance Insights 操作  |  Amazon CLI command  |  描述  | 
| --- | --- | --- | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_CreatePerformanceAnalysisReport.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_CreatePerformanceAnalysisReport.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/CreatePerformanceAnalysisReport.html](https://docs.amazonaws.cn/cli/latest/reference/pi/CreatePerformanceAnalysisReport.html)  |  为数据库实例创建特定时间段的性能分析报告。结果为 `AnalysisReportId`，这是报告的唯一标识符。  | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_DeletePerformanceAnalysisReport.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_DeletePerformanceAnalysisReport.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/DeletePerformanceAnalysisReport.html](https://docs.amazonaws.cn/cli/latest/reference/pi/DeletePerformanceAnalysisReport.html)  |  删除性能分析报告。  | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_DescribeDimensionKeys.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/describe-dimension-keys.html](https://docs.amazonaws.cn/cli/latest/reference/pi/describe-dimension-keys.html)  |  对于特定的时间段，检索指标的前 N 个维度键。  | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetDimensionKeyDetails.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/get-dimension-key-details.html](https://docs.amazonaws.cn/cli/latest/reference/pi/get-dimension-key-details.html)  |  检索数据库实例或数据源的指定维度组的属性。例如，如果您指定了 SQL ID，并且有维度详细信息，则 `GetDimensionKeyDetails` 将检索与此 ID 关联的维度 `db.sql.statement` 的全文。此操作很有用，因为 `GetResourceMetrics` 和 `DescribeDimensionKeys` 不支持检索大型 SQL 语句文本。  | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetPerformanceAnalysisReport.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetPerformanceAnalysisReport.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/GetPerformanceAnalysisReport.html](https://docs.amazonaws.cn/cli/latest/reference/pi/GetPerformanceAnalysisReport.html)  |  检索报告，包括报告的见解。结果包括报告状态、报告 ID、报告时间详情、见解和建议。  | 
| [GetResourceMetadata](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetResourceMetadata.html) |  [https://docs.amazonaws.cn/cli/latest/reference/pi/get-resource-metadata.html](https://docs.amazonaws.cn/cli/latest/reference/pi/get-resource-metadata.html)  |  检索不同功能的元数据。例如，元数据可以表明特定数据库实例上的某个功能已打开或关闭。  | 
|  [https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetResourceMetrics.html](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_GetResourceMetrics.html)  |  [https://docs.amazonaws.cn/cli/latest/reference/pi/get-resource-metrics.html](https://docs.amazonaws.cn/cli/latest/reference/pi/get-resource-metrics.html)  |  检索一组数据来源在一段时间内的 Performance Insights 指标。您可以提供特定维度组和维度，并为每个组提供聚合和筛选条件。  | 
| [ListAvailableResourceDimensions](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_ListAvailableResourceDimensions.html) |  [https://docs.amazonaws.cn/cli/latest/reference/pi/list-available-resource-dimensions.html](https://docs.amazonaws.cn/cli/latest/reference/pi/list-available-resource-dimensions.html)  |  检索特定实例上每个特定指标类型可查询的维度。  | 
| [ListAvailableResourceMetrics](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_ListAvailableResourceMetrics.html) |  [https://docs.amazonaws.cn/cli/latest/reference/pi/list-available-resource-metrics.html](https://docs.amazonaws.cn/cli/latest/reference/pi/list-available-resource-metrics.html)  |  检索指定指标类型的所有可用指标，指定数据库实例可用该指标进行查询。  | 
|  `[ListPerformanceAnalysisReports](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_ListPerformanceAnalysisReports.html)` |  [https://docs.amazonaws.cn/cli/latest/reference/pi/list-performance-analysis-reports.html](https://docs.amazonaws.cn/cli/latest/reference/pi/list-performance-analysis-reports.html)  | 检索数据库实例的所有可用分析报告。这些报告根据每个报告的开始时间列出。 | 
|  `[ListTagsForResource](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_ListTagsForResource.html)` |  [https://docs.amazonaws.cn/cli/latest/reference/pi/list-tags-for-resource.html](https://docs.amazonaws.cn/cli/latest/reference/pi/list-tags-for-resource.html)  |  列出添加到资源的所有元数据标签。该列表包含标签的名称和值。  | 
|  `[TagResource](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_TagResource.html)` |  [https://docs.amazonaws.cn/cli/latest/reference/pi/tag-resource.html](https://docs.amazonaws.cn/cli/latest/reference/pi/tag-resource.html)  |  将元数据标签添加到 Amazon RDS 资源中。该标签包含名称和值。  | 
|  `[UntagResource](https://docs.amazonaws.cn/performance-insights/latest/APIReference/API_UntagResource.html)` |  [https://docs.amazonaws.cn/cli/latest/reference/pi/untag-resource.html](https://docs.amazonaws.cn/cli/latest/reference/pi/untag-resource.html)  |  从资源中删除元数据标签。  | 

有关检索性能详情的时间序列指标和 Amazon CLI 示例的更多信息，请参阅以下主题。

**Topics**
+ [检索性能详情的时间序列指标](USER_PerfInsights.API.TimeSeries.md)
+ [Performance Insights 的 Amazon CLI 示例](USER_PerfInsights.API.Examples.md)