全部產品
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
            }
          ]
        }
      }
    ]
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。