文档

DescribeMetricsData - 查询监控指标数据

更新时间:

该接口用于查询 OceanBase 集群的单维度或者多维度监控指标数据。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
StartTimestring

查询监控指标数据的起始时间。 该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-06-13T15:40:43Z
EndTimestring

查询监控指标数据的结束时间。 该时间只支持 UTC 时间,格式为:YYYY-MM-DDThh:mm:ssZ。

2021-06-13T15:40:43Z
Metricsstring

监控指标。
多个指标之间用逗号分隔。例如:"tps,qps,qps_rt,tps_rt..."。

tps
Labelsstring

一组 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***
GroupByLabelsstring

用于分组的字段。多个字段之间用逗号分隔。例如:"app,clusterId,tenantId" 。

app,clusterId
SortMetricKeystring

排序列。

tps
SortOrderstring

排序规则。

  • 升序:ASC。
  • 降序:DESC。
DESC
Limitstring

排序后返回的 Data 数组长度。

5

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C
Datastring

返回数据。

[ { "sql_select_count":75.****15****1515, "timestamp":165079**** }, ...... ]

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
  "Data": "[\n                {\n                    \"sql_select_count\":75.****15****1515,\n                    \"timestamp\":165079****\n                },\n                ......\n            ]"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-26OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ReplicaType
  • 本页导读 (0)
文档反馈