该接口用于查询 OceanBase 集群的单维度或者多维度监控指标数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 是 | 监控指标。 | tps |
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 | 否 | 排序规则。
| DESC |
Limit | string | 否 | 排序后返回的 Data 数组长度。 | 5 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EE205C00-30E4-xxxx-xxxx-87E3A8A2AA0C",
"Data": [
""
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2024-04-15 | OpenAPI 返回结构发生变更 | 看变更集 | ||||
| ||||||
2023-12-26 | OpenAPI 入参发生变更 | 看变更集 | ||||
|