DescribeMetricsData - 查詢監控指標資料 - ApsaraDB for OceanBase (Deprecated)

該介面用於查詢 OceanBase 叢集的單維度或者多維度監控指標資料。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeMetricsData

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
StartTime	string	是	查詢監控指標資料的起始時間。該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2021-06-13T15:40:43Z
EndTime	string	是	查詢監控指標資料的結束時間。該時間只支援 UTC 時間，格式為：YYYY-MM-DDThh:mm:ssZ。	2021-06-13T15:40:43Z
Metrics	string	是	監控指標。多個指標之間用逗號分隔。例如："sql_all_count,sql_all_rt..."。	sql_all_count
Labels	string	是	一組 kv 組成的字串，key、value 之間用逗號分隔，kv 對之間用逗號分隔。例如："app:OB,clusterId:ob***,tenantId:t**,serverId:***,zoneId:cn-hangzhou-j"。 k 為固定欄位： app：表示應用類型，目前僅支援 OceanBase。 clusterId：表示 OceanBase 叢集 ID。 tenantId：表示 OceanBase 租戶 ID。 zoneId：表示 ob zone id serverId：表示 OBServer 節點 ID。	app:OB,clusterId:ob***
GroupByLabels	string	是	用於分組的欄位。多個欄位之間用逗號分隔。例如："app,clusterId,tenantId" 。	app,clusterId
SortMetricKey	string	否	排序列。	tps
SortOrder	string	否	定序。升序：ASC。降序：DESC。	DESC
Limit	string	否	排序後返回的 Data 數組長度。	5
ReplicaType	string	否	副本類型。 OceanBase 叢集監控根據副本類型設定節點過濾條件。預設不傳, 可用於 OceanBase 監控或查詢訪問代理監控，查詢 OceanBase 監控時，表示查詢所有副本類型節點的監控資料。 FULL，僅對 OceanBase 監控生效，表示只查詢全功能副本節點上的監控資料。 READONLY，僅對 OceanBase 監控生效，表示只查詢唯讀副本節點上的監控資料。	FULL
MetricScope	string	否

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array	返回資料。	[ { "sql_select_count":75.**151515, "timestamp":165079** }, ...... ]
	string	返回資料。	[{'clusterId': 'ob5b8*******', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*******'}]

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    "[{'clusterId': 'ob5b8*********', 'Data': [{'timestamp': 1702434300, 'sql_all_rt': 0.64}, {'timestamp': 1702434240, 'sql_all_rt': 0.0}], 'tenantId': 't5b8*********'}]"
  ]
}

錯誤碼

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

變更歷史

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