DescribeMetricsData - 查询监控指标数据 - 云数据库 OceanBase

该接口用于查询 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

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array	返回数据。
Data	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*********'}]"
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-04-15	OpenAPI 返回结构发生变更	查看变更详情
2023-12-26	OpenAPI 入参发生变更	查看变更详情