使用DescribeMetricsDataV2查询监控指标数据-云数据库 OceanBase 版-阿里云

返回用户监控数据

调试

您可以在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>	请求返回的信息。
Data	object	返回数据。
Labels	object	数据标签。
	string	标签详情。	clusterId:ob********
Data	array<object>	请求返回的信息。
Data	object	返回数据。
MetricValue	object	监控指标数据
	string	指标数据。	'load1': 1.29
Timestamp	long	时间戳	1702434300

示例

正常返回示例

JSON格式

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

错误码

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