該接口用于查詢 OceanBase 集群的單維度或者多維度監(jiān)控指標數(shù)據(jù)。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產(chǎn)品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
oceanbase:DescribeMetricsData | get | *全部資源 * |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
StartTime | string | 是 | 查詢監(jiān)控指標數(shù)據(jù)的起始時間。 該時間只支持 UTC 時間,格式為:YYYY-MM-DDThh:mm:ssZ。 | 2021-06-13T15:40:43Z |
EndTime | string | 是 | 查詢監(jiān)控指標數(shù)據(jù)的結(jié)束時間。 該時間只支持 UTC 時間,格式為:YYYY-MM-DDThh:mm:ssZ。 | 2021-06-13T15:40:43Z |
Metrics | string | 是 | 監(jiān)控指標。 | sql_all_count |
Labels | string | 是 | 一組 kv 組成的字符串,key、value 之間用逗號分隔,kv 對之間用逗號分隔。例如:"app:OB,clusterId:ob*****,tenantId:t******,serverId:*****,zoneId:cn-hangzhou-j"。
| app:OB,clusterId:ob*** |
GroupByLabels | string | 是 | 用于分組的字段。多個字段之間用逗號分隔。例如:"app,clusterId,tenantId" 。 | app,clusterId |
SortMetricKey | string | 否 | 排序列。 | tps |
SortOrder | string | 否 | 排序規(guī)則。
| DESC |
Limit | string | 否 | 排序后返回的 Data 數(shù)組長度。 | 5 |
ReplicaType | string | 否 | 副本類型。
| FULL |
返回參數(shù)
示例
正常返回示例
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*********'}]"
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-04-15 | OpenAPI 返回結(jié)構發(fā)生變更 | 查看變更詳情 |
2023-12-26 | OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |