DescribeDBClusterPerformance - 查看实例性能数据 - 云原生数据仓库AnalyticDB

查看AnalyticDB PostgreSQL版实例在指定时间段的性能监控。

接口说明

仅支持查询 30 天内的监控信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:DescribeDBClusterPerformance

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp12ga6v69h86****
Key	string	是	性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见性能参数表。	adbpg_conn_count
StartTime	string	是	查询开始时间，格式为`YYYY-MM-DDTHH:mmZ`。说明仅支持查询 30 天内的监控信息。	2021-11-03T15:00Z
EndTime	string	是	查询结束时间，格式为`YYYY-MM-DDTHH:mmZ`。说明查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过 7 天。	2021-11-03T15:10Z
Nodes	string	否	用于查询一个或多个节点的监控指标，多个节点名称间使用英文逗号（,）分隔，例如`master-10****1,master-10**2`。您可以调用 DescribeDBClusterNode 接口获取节点名称。您也可以根据监控指标的高低筛选节点，取值说明： top10：监控指标最高的十个节点。 top20：监控指标最高的二十个节点。 bottom10：监控指标最低的十个节点。 bottom20**：监控指标最低的二十个节点。	top10
NodeType	string	否	节点类型。取值说明： master：Master 节点。 segment：Segment 节点。说明如果不传入该参数，则返回所有节点的监控指标。	master
ResourceGroupName	string	否	资源组名称。	testgroup

返回参数

名称	类型	描述	示例值
	object
PerformanceKeys	array<object>	实例性能参数值列表。
	array<object>
Unit	string	监控指标的单位。	%
Series	array<object>	性能参数集合。
	array<object>
Values	array<object>	性能参数值，每个值对应一个采集时间点。
	object
Point	array	性能参数值。
	string	性能监控具体信息，由时间和性能参数值构成。	["2021-11-03T15:00:00+08:00","5.84"]
Role	string	节点的角色，取值说明： master：主节点。 standby：备节点。 segment：计算节点。	standby
Name	string	计算节点或计算组名称。	standby-********-cpu
Name	string	性能参数名称，具体信息，请参见性能参数表。	adbpg_group_cpu_used_percent
EndTime	string	查询结束时间（UTC 时间），格式为`YYYY-MM-DDTHH:mmZ`。	2021-11-03T15:10Z
RequestId	string	请求 ID。	8E8990F0-C81E-4C94-8F51-5F**********
StartTime	string	查询开始时间（UTC 时间），格式为`YYYY-MM-DDTHH:mmZ`。	2021-11-03T15:00Z
DBClusterId	string	实例 ID。	gp-bp12ga6v69h86****

示例

正常返回示例

JSON格式

{
  "PerformanceKeys": [
    {
      "Unit": "%",
      "Series": [
        {
          "Values": [
            {
              "Point": [
                "[\"2021-11-03T15:00:00+08:00\",\"5.84\"]"
              ]
            }
          ],
          "Role": "standby",
          "Name": "standby-********-cpu"
        }
      ],
      "Name": "adbpg_group_cpu_used_percent"
    }
  ],
  "EndTime": "2021-11-03T15:10Z",
  "RequestId": "8E8990F0-C81E-4C94-8F51-5F**********",
  "StartTime": "2021-11-03T15:00Z",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。