全部產品
Search

搜尋本產品

    PolarDB：DescribeDBProxyPerformance - 查詢PolarDB代理層（PolarProxy）的效能資料

    文件中心

    PolarDB：DescribeDBProxyPerformance - 查詢PolarDB代理層（PolarProxy）的效能資料

    更新時間：May 20, 2026

    查詢PolarDB代理層（PolarProxy）的效能資料。

    介面說明

    說明

    該介面僅適用於 PolarDB MySQL 版。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:DescribeDBProxyPerformance

    get

    *DBCluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    叢集 ID。

    pc-****************
    DBEndpointId

    string

    否

    資料庫代理串連地址 ID。支援叢集地址與自訂地址的查詢，不支援主地址的查詢。不傳則預設查詢叢集地址。

    pe-****************
    Interval

    string

    否

    效能資料粒度。取值範圍如下：

    • 5

    • 30

    • 60

    • 600

    • 1800

    • 3600

    • 86400

    60
    Type

    string

    否

    特殊指標，目前僅支援 tair（PolarTair 架構）。

    tair
    Key

    string

    是

    查詢的效能指標，多個值間用英文逗號（,）分隔，詳細參數請參見績效參數表。

    PolarProxy_CpuUsage
    StartTime

    string

    是

    查詢開始時間。格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2020-09-23T01:01Z
    EndTime

    string

    是

    查詢結束時間。格式為yyyy-MM-ddTHH:mmZ（UTC 時間）。

    2020-09-24T02:08Z
    DBNodeId

    string

    否

    資料庫執行個體節點 ID。用於查詢 Proxy 在不同 DB 節點上的指標，支援指標為 PolarProxy_DBConns、PolarProxy_DBQps、PolarProxy_DBActionOps。

    pi-****************

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PerformanceKeys

    object

    PerformanceItem

    array<object>

    叢集效能資料列表。

    array<object>

    MetricName

    string

    具體的效能指標度量名稱。

    service_connections_ps
    Measurement

    string

    效能指標。

    PolarProxy_CpuUsage
    Points

    object

    PerformanceItemValue

    array<object>

    效能資料數組。

    object

    Value

    string

    監控指標資料值。

    10
    Timestamp

    integer

    監控指標的具體時間點，格式為時間戳記，單位為毫秒。

    1600822800000
    DBNodeId

    string

    資料庫叢集節點 ID。

    pi-*************
    DBVersion

    string

    相容資料庫版本。

    8.0
    EndTime

    string

    查詢結束時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2020-09-23T01:01:00Z
    RequestId

    string

    請求 ID。

    35D3E3DA-4650-407A-BFF5-59BFF1******
    StartTime

    string

    查詢開始時間。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。

    2020-09-23T01:00:00Z
    DBClusterId

    string

    資料庫叢集 ID。

    pc-*****************
    DBType

    string

    相容資料庫類型。

    MySQL

    樣本

    正常返回樣本

    JSON格式

    {
  "PerformanceKeys": {
    "PerformanceItem": [
      {
        "MetricName": "service_connections_ps",
        "Measurement": "PolarProxy_CpuUsage",
        "Points": {
          "PerformanceItemValue": [
            {
              "Value": "10",
              "Timestamp": 1600822800000
            }
          ]
        },
        "DBNodeId": "pi-*************"
      }
    ]
  },
  "DBVersion": "8.0",
  "EndTime": "2020-09-23T01:01:00Z",
  "RequestId": "35D3E3DA-4650-407A-BFF5-59BFF1******",
  "StartTime": "2020-09-23T01:00:00Z",
  "DBClusterId": "pc-*****************",
  "DBType": "MySQL"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameterCombination The end time must be greater than the start time. 結束時間必須大於開始時間
    400 InvalidStartTime.Malformed The specified parameter StartTime is not valid. 指定的參數StartTime無效
    400 InvalidEndTime.Malformed The specified parameter EndTime is not valid. 指定的參數EndTime無效
    400 InvalidKey.Malformed The specified parameter Key is not valid. 指定的參數鍵無效
    404 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的 DBClusterId。
    404 InvalidDBEndpointId.NotFound The DBEndpointId provided does not exist in our records. 當前的記錄中不存在提供的DBEndpointId。

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

    變更歷史

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