全部产品
Search

搜索本产品

    云原生数据库 PolarDB：DescribeDBNodePerformance - 查询实例性能数据

    文档中心

    云原生数据库 PolarDB：DescribeDBNodePerformance - 查询实例性能数据

    更新时间：Sep 10, 2026

    调用DescribeDBNodePerformance接口查询实例性能数据。

    接口说明

    注意：

    • endpoint 和其他接口有区别，国内和新加坡需使用polardbx.aliyuncs.com， 其他地域使用polardbx.{region id}.aliyunc.com。

    • 调试此 API 接口的时候，如果报服务不可用的错，请确认下 endpoint 是否正确，可通过切换服务地址到迪拜或者印度，将 endpoint 切换到polardbx.aliyuncs.com。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    polardbx:DescribeDBNodePerformance

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Key

    string

    是

    指标名称，多个用英文逗号分隔，最多 6 个。详细内容请参见性能参数表章节。

    Cpu_Usage,Mem_Usage
    StartTime

    string

    是

    查询开始时间, 格式： YYYY-MM-ddTHH:mmZ（UTC 时间）。

    2012-06-08T15:00Z
    DBInstanceName

    string

    是

    PolarDB-X 实例名称。

    pxc-*******
    DBNodeIds

    string

    是

    节点名称，多个用英文逗号分隔，CDC 节点和计算节点一次最多支持 10 个节点，数据节点一次最多支持 1 个节点。

    pxc-i-******,pxc-i-*******
    CharacterType

    string

    是

    节点类型。目前包含 polarx_cn、polarx_dn、polarx_cdc、polarx_gms、polarx_columnar。

    polarx_cn
    DBNodeRole

    string

    否

    节点类型，取值：

    • master：主节点

    • slave：备节点。 针对 DN 和 GMS 节点。

    • standby： 备节点。针对 CN 节点。

    master
    RegionId

    string

    是

    地域 ID。

    cn-hangzhou
    EndTime

    string

    是

    查询结束时间, 格式： YYYY-MM-ddTHH:mmZ（UTC 时间）。

    2012-06-18T15:00Z

    返回参数

    名称

    类型

    描述

    示例值

    object

    EndTime

    string

    查询结束时间, 格式： YYYY-MM-ddTHH:mm:ssZ（UTC 时间）。

    2021-10-20T02:00Z
    StartTime

    string

    查询开始时间, 格式： YYYY-MM-ddTHH:mm:ssZ（UTC 时间）。

    2021-10-20T00:00Z
    DBInstanceName

    string

    实例名称。

    pxc-********
    RequestId

    string

    请求 ID。

    EFB5E10B-5268-170F-A378-9AF86CCEACC8
    PerformanceKeys

    object

    PerformanceItem

    array<object>

    性能数据列表。

    array<object>

    MetricName

    string

    具体的性能指标度量名称。

    logic_tps
    DBNodeId

    string

    节点名称。

    pxc-i-********
    Measurement

    string

    性能指标。

    Logic_TPS
    Points

    object

    PerformanceItemValue

    array<object>

    性能数据数组。

    object

    Value

    string

    监控指标数据值。

    42.38
    Timestamp

    integer

    监控指标的具体时间点，格式为时间戳，单位为毫秒。

    1600822800000

    示例

    正常返回示例

    JSON格式

    {
  "EndTime": "2021-10-20T02:00Z",
  "StartTime": "2021-10-20T00:00Z",
  "DBInstanceName": "pxc-********",
  "RequestId": "EFB5E10B-5268-170F-A378-9AF86CCEACC8",
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "logic_tps",
        "DBNodeId": "pxc-i-********",
        "Measurement": "Logic_TPS",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "42.38",
              "Timestamp": 1600822800000
            }
          ]
        }
      }
    ]
  }
}

    错误码

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

    变更历史

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