文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 指标管理/ 查询实例指标数据
更新时间：2025-10-14 GMT+08:00
查看PDF
分享

查询实例指标数据

功能介绍

查询实例指标数据。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/metric-data

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

start_time

是

String

参数解释：

开始时间，时间戳格式，例如：1756971683303。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

是

String

参数解释：

结束时间，时间戳格式，例如：1756975283303。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

metric

是

Array

参数解释：

指标ID，可通过“查询指标分组的指标名称”接口获取，例如查询CPU使用率，传值 rds001_cpu_util。

约束限制：

不涉及。

node_id

是

Array

参数解释：

节点ID。

约束限制：

不涉及。

component_id

否

Array

参数解释：

组件ID，例如dn_6001。

约束限制：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us。

响应参数

表4 响应Body参数

参数

参数类型

描述

instance_id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

metrics

Array of MetricDataResult objects

参数解释：

指标数据集合。详情请参见表5。
表5 MetricDataResult字段数据结构说明

参数

参数类型

描述

metric

String

参数解释：

指标ID。

取值范围：

不涉及。

type

String

参数解释：

指标类型。

取值范围：

  • INSTANCE：实例类型。
  • NODE：节点类型。
  • COMPONENT：组件类型。

unit

String

参数解释：

指标单位。

取值范围：

不涉及。

datapoints

Array of DatapointResult objects

参数解释：

指标维度及指标值。详情请参见表6

timestamps

Array of Strings

参数解释：

时间戳。
表6 DatapointResult字段数据结构说明

参数

参数类型

描述

datapoint_name

String

参数解释：

指标项名，实例指标用实例ID、节点指标用节点名称、组件指标用组件名称。

取值范围：

不涉及。

datapoint_values

Array of Strings

参数解释：

指标值集合。

请求示例

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/e73893ef73754465a8bd2e0857bbf13ein14/metric-data?start_time=1699260798398&end_time=1699319598743&metric=rds001_cpu_util,rds002_mem_util&node_id=6b7616dfb1c14721b1a11dd5654c1515no14,ef3af6ce4d064eb28d38eff00ff96dfano14&component_id=dn_6001,dn_6002

响应示例

{ 
  "instance_id" : "f7fb5cda6f134275830e4e3af80788aein14", 
  "metrics" : [ { 
    "metric" : "rds036_deadlocks", 
    "type" : "INSTANCE", 
    "unit" : "Count", 
    "datapoints" : [ { 
      "datapoint_name" : "f7fb5cda6f134275830e4e3af80788aein14", 
      "datapoint_values" : [ 0, 1 ] 
    } ], 
    "timestamps" : [ 1699495140000, 1699495200000 ] 
  }, { 
    "metric" : "rds001_cpu_util", 
    "type" : "NODE", 
    "unit" : "%", 
    "datapoints" : [ { 
      "datapoint_name" : "node_01", 
      "datapoint_values" : [ 24.29, 37.81 ] 
    }, { 
      "datapoint_name" : "node_02", 
      "datapoint_values" : [ 18.8, 17.69 ] 
    } ], 
    "timestamps" : [ 1699495140000, 1699495200000 ] 
  }, { 
    "metric" : "rds008_disk_used_size", 
    "type" : "COMPONENT", 
    "unit" : "GB", 
    "datapoints" : [ { 
      "datapoint_name" : "dn_6001", 
      "datapoint_values" : [ 1.61, 1.62 ] 
    }, { 
      "datapoint_name" : "dn_6002", 
      "datapoint_values" : [ 1.64, 1.66 ] 
    } ], 
    "timestamps" : [ 1699495140000, 1699495200000 ] 
  } ] 
}

状态码

错误码

请参见错误码。

父主题： 指标管理

相关文档