DescribeMetricsData_云数据库 OceanBase 版_API文档

2019-09-01

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

oceanbase:DescribeMetricsData	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
InstanceIdstring	OceanBase 集群 ID。示例值:ob317v4uif****参考取值来源: CreateInstance ModifyInstanceSSL DescribeInstances
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	监控指标。多个指标之间用逗号分隔。例如："sql_all_count,sql_all_rt..."。示例值:sql_all_count
Labelsstring	一组 kv 组成的字符串，key、value 之间用逗号分隔，kv 对之间用逗号分隔。例如："app:OB,clusterId:ob***,tenantId:t**,serverId:*,zoneId:cn-hangzhou-j"。展开详情示例值:app:OB,clusterId:ob*
GroupByLabelsstring	用于分组的字段。多个字段之间用逗号分隔。例如："app,clusterId,tenantId" 。示例值:app,clusterId
SortMetricKeystring	排序列。示例值:tps
SortOrderstring	排序规则。展开详情示例值:DESC
Limitstring	排序后返回的 Data 数组长度。示例值:5
ReplicaTypestring	副本类型。展开详情示例值:FULL枚举值:FULLREADONLY

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:EE205C00-30E4-**-**-87E3A8A2AA0C
Dataarray<string>	返回数据。示例值:[ { "sql_select_count":75.**151515, "timestamp":165079** }, ...... ]

返回示例

变更历史

	变更时间	变更内容概要	操作
	2024-04-15	变更返回参数
	2023-12-26	新增请求参数ReplicaType 删除返回参数

相关示例