全部产品
Search
文档中心

云原生数据仓库AnalyticDB:DescribeDBClusterResourcePoolPerformance - 查询集群资源池监控信息

更新时间:Dec 11, 2024

查询弹性模式集群版(新版)ADB集群的资源池监控信息。

接口说明

说明 您还可以在控制台上以图表的形式查看 AnalyticDB MySQL 版弹性模式集群版(新版)资源池监控信息。更多详细信息,请参见查看监控信息

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:DescribeDBClusterResourcePoolPerformanceget
*DBCluster
acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有 AnalyticDB MySQL 集群的详情,包括集群 ID。
am-****************
Keystring

资源池数据监控指标。允许同时输入多个指标进行查询,多个指标间用英文逗号(,)分隔。支持监控如下指标:

  • AnalyticDB_RP_CPU :CPU 平均使用率,单位:%。
  • AnalyticDB_RP_RT:查询响应时间(RT),单位:毫秒(ms)。
  • AnalyticDB_RP_QPS:每秒查询率(QPS),单位:数值。
  • AnalyticDB_RP_WaitTime:查询等待时间,单位:毫秒(ms)。
  • AnalyticDB_RP_OriginalNode:资源池基础节点数。
  • AnalyticDB_RP_ActualNode:资源池分时弹性实际弹出的节点数(即执行扩容计划时实际增加的节点数)。
  • AnalyticDB_RP_PlanNode:资源池分时弹性计划弹出的节点数。
  • AnalyticDB_RP_TotalNode:资源池拥有的总节点数,总节点数=基础节点数+分时弹性计划中实际生效的节点数。
说明
  • 若该参数留空,默认返回所有指标的监控数据详情。
  • 更多关于资源池弹性计划的信息,请参见资源弹性扩容
  • AnalyticDB_RP_CPU
    ResourcePoolsstring

    目标资源池名称。允许同时输入多个资源池名称进行查询,多个名称间用英文逗号(,)分隔。

    说明
  • 输入的资源池名称不区分大小写,例如USER_DEFAULTuser_default表示的是同一个资源池。
  • 若该参数留空,将返回USER_DEFAULT即默认资源池的监控信息。
  • TEST_POOL
    StartTimestring

    资源池数据监控开始时间。格式为 yyyy-MM-ddTHH:mmZ(UTC 时间)。

    说明 仅支持查看最近 2 天的资源池监控信息。
    2021-06-10T07:00Z
    EndTimestring

    资源池数据监控结束时间,结束时间需晚于开始时间。格式为 yyyy-MM-ddTHH:mmZ(UTC 时间)。

    2021-06-10T07:01Z

    返回参数

    名称类型描述示例值
    object

    详情。

    EndTimestring

    资源池数据监控结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2021-06-10T07:01:00Z
    RequestIdstring

    请求 ID。

    C7EDB8E4-9769-4233-88C7-DCA4C9******
    StartTimestring

    资源池数据监控开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2021-06-10T07:00:00
    DBClusterIdstring

    集群 ID。

    am-****************
    Performancesarray<object>

    以监控指标为维度的数据详情列表。

    PerformanceItemobject

    详情。

    Keystring

    资源池数据监控指标。

    AnalyticDB_RP_CPU
    Unitstring

    监控指标的单位。

    %
    ResourcePoolPerformancesarray<object>

    以资源池为维度的监控数据列表。

    ResourcePoolPerformancesItemobject

    详情。

    ResourcePoolNamestring

    资源池名称。

    test_pool
    ResourcePoolSeriesarray<object>

    资源池监控数据的序列列表。

    ResourcePoolSeriesItemobject

    详情。

    Valuesarray

    监控指标数值。

    Valuesstring

    不同时间点下的资源池监控项数值。

    ["2021-06-10T07:00:22.601Z","0.0000"],["2021-06-10T07:00:52.62Z","0.0312"]
    Namestring

    监控指标名称。

    cpu

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2021-06-10T07:01:00Z",
      "RequestId": "C7EDB8E4-9769-4233-88C7-DCA4C9******",
      "StartTime": "2021-06-10T07:00:00",
      "DBClusterId": "am-****************",
      "Performances": [
        {
          "Key": "AnalyticDB_RP_CPU",
          "Unit": "%",
          "ResourcePoolPerformances": [
            {
              "ResourcePoolName": "test_pool",
              "ResourcePoolSeries": [
                {
                  "Values": [
                    "[\"2021-06-10T07:00:22.601Z\",\"0.0000\"],[\"2021-06-10T07:00:52.62Z\",\"0.0312\"]"
                  ],
                  "Name": "cpu"
                }
              ]
            }
          ]
        }
      ]
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedThe specified StartTime is invalid.StarTime参数不正确
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

    变更历史

    变更时间变更内容概要操作
    2023-04-06OpenAPI 错误码发生变更查看变更详情