全部产品
Search

搜索本产品

    云数据库 OceanBase （文档停止维护）：DescribeNodeMetrics - 查询节点指标信息

    文档中心

    云数据库 OceanBase （文档停止维护）：DescribeNodeMetrics - 查询节点指标信息

    更新时间：Aug 28, 2026

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

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    oceanbase:DescribeNodeMetrics

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    OceanBase 集群 ID。

    ob317v4uif****
    PageSize

    integer

    否

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

    • 最大值：100。

    • 默认值：10。

    10
    PageNumber

    integer

    否

    分页查询的页码。

    • 起始值：1。

    • 默认值：1。

    1
    TenantId

    string

    否

    租户 ID。

    tfafd34fs****
    StartTime

    string

    是

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

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

    string

    是

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

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

    string

    是

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

    tps
    NodeName

    string

    否

    节点名称。

    i-bp16niirq4zdmgvm****
    NodeIdList

    string

    否

    节点列表。

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

    返回参数

    名称

    类型

    描述

    示例值

    object

    请求的返回结果。

    TotalCount

    integer

    总数量。

    9
    RequestId

    string

    请求 ID。

    EE205C00-30E4-****-****-87E3A8A2AA0C
    NodeMetrics

    string

    节点指标信息。

    -

    示例

    正常返回示例

    JSON格式

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

    错误码

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

    变更历史

    更多信息，参考变更详情。