DescribeMetricsDataV2 - 查詢監控指標資料

更新時間:
Copy as MD

返回使用者監控資料

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

string

OceanBase 叢集 ID。

ob317v4uif****

Metrics

string

監控指標。
多個指標之間用逗號分隔。例如:"sql_all_count,sql_all_rt..."。

sql_all_rt

StartTime

string

開始時間 YYYY-MM-DDThh:mm:ssZ

2023-04-12T04:38:38Z

EndTime

string

結束時間 YYYY-MM-DDThh:mm:ssZ

2023-04-12T05:38:38Z

Labels

string

一組 kv 組成的字串,key、value 之間用冒號分隔,kv 對之間用逗號分隔,同一 key 不同 value 間用分號分隔。例如:"clusterId:ob*****,tenantId:t******;t*******,serverId:*****,zoneId:cn-hangzhou-j"。
key 為固定欄位:

  • clusterId:表示 OceanBase 叢集 ID。

  • tenantId:表示 OceanBase 租戶 ID。

  • zoneId:表示 OB zone ID。

  • serverId:表示 OBServer 節點 ID。

clusterId:ob***

GroupByLabels

string

用於分組的欄位。多個欄位之間用逗號分隔。例如:"clusterId,tenantId" 。

clusterId

SortMetricKey

string

排序列。

tps

SortOrder

string

定序。

  • 升序:ASC。

  • 降序:DESC。

DESC

Limit

string

排序後返回的 Data 數組長度。

20

ReplicaType

string

副本類型。
OceanBase 叢集監控根據副本類型設定節點過濾條件。

  • 預設不傳, 可用於 OceanBase 監控或查詢訪問代理監控,查詢 OceanBase 監控時,表示查詢所有副本類型節點的監控資料。

  • FULL,僅對 OceanBase 監控生效,表示只查詢全功能副本節點上的監控資料。

  • READONLY,僅對 OceanBase 監控生效,表示只查詢唯讀副本節點上的監控資料。

FULL

返回參數

名稱

類型

描述

樣本值

object

請求的返回結果。

RequestId

string

請求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C

Data

array<object>

請求返回的資訊。

array<object>

返回資料。

Labels

object

資料標籤。

string

標籤詳情。

clusterId:ob********

Data

array<object>

請求返回的資訊。

array<object>

返回資料。

MetricValue

object

監控指標資料

string

指標資料。

'load1': 1.29

Timestamp

integer

時間戳記

1702434300

樣本

正常返回樣本

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "Labels": {
        "key": "clusterId:ob********"
      },
      "Data": [
        {
          "MetricValue": {
            "key": "'load1': 1.29"
          },
          "Timestamp": 1702434300
        }
      ]
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情