DescribeNodeMetrics - 查询节点指标信息

查询一个 OceanBase 节点指标信息。

调试

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

授权信息

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:100。
  • 默认值:10。
10
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1
TenantIdstring

租户 ID。

tfafd34fs****
StartTimestring

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

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

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

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

监控指标项。 当前可支持的指标及说明请参考 节点监控数据详情

tps
NodeNamestring

节点名称。

i-bp16niirq4zdmgvm****
NodeIdListstring

节点列表。

[i-bp16niirq4zdmgvm****,i-bp16n56hq4z4fgvm****]

返回参数

名称类型描述示例值
object

请求的返回结果。

TotalCountinteger

总数量。

9
RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
NodeMetricsstring

节点指标信息。

-

示例

正常返回示例

JSON格式

{
  "TotalCount": 9,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "NodeMetrics": "-"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-01-17API 内部配置变更,不影响调用查看变更详情
2022-01-17OpenAPI 入参发生变更查看变更详情