使用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****"
}

錯誤碼

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

變更歷史

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