# 查询实例指标数据 - QueryingMetricsofaSpecificDBInstance #### 功能介绍 查询实例指标数据。 - 调用接口前，您需要了解API [认证鉴权](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_011.html)。 - 调用接口前，您需要提前获取到[地区和终端节点](https://developer.huaweicloud.com/endpoint)。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforopenGauss&api=ShowInstanceMetricData)中调试该接口。 #### URI GET /v3/{project_id}/instances/{instance_id}/metric-data 表1参数说明 | 名称 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一Region下的项目ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_196.html)。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | | instance_id | 是 | String | **参数解释：** 实例ID，此参数是用户创建实例的唯一标识。请参考[查询数据库实例列表 - QueryingDBInstances](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_328.html)接口获取实例ID。 **约束限制：** 不涉及。 **取值范围：** 只能由英文字母、数字组成，且长度为36个字符。 **默认取值** **：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | start_time | 是 | String | **参数解释：** 开始时间，时间戳格式，例如：1756971683303。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | end_time | 是 | String | **参数解释：** 结束时间，时间戳格式，例如：1756975283303。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值** **：** 不涉及。 | | metric | 是 | Array | **参数解释：** 指标ID，可通过"[查询指标分组的指标名称](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_214.html)"接口获取，例如查询CPU使用率，传值 rds001_cpu_util。 **约束限制：** 不涉及。 | | node_id | 是 | Array | **参数解释：** 节点ID。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 不涉及。 | | component_id | 否 | Array | **参数解释：** 组件ID，例如dn_6001。获取方式请参考[查询实例的组件列表 - QueryingtheComponentsofaDBInstance](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_028.html)。 **约束限制：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 请求响应成功后在响应消息头中包含的"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]。 | 表5MetricDataResult字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | metric | String | **参数解释：** 指标ID。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 指标类型。 **取值范围：** - INSTANCE：实例类型。 - NODE：节点类型。 - COMPONENT：组件类型。 | | unit | String | **参数解释：** 指标单位。 **取值范围：** 不涉及。 | | datapoints | Array of DatapointResult objects | **参数解释：** 指标维度及指标值。详情请参见[表6] | | timestamps | Array of Strings | **参数解释：** 时间戳。 | 表6DatapointResult字段数据结构说明 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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" ] } ] } ``` #### 状态码 - 正常 200 - 异常 请参见[状态码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_194.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-gaussdb/gaussdb_api_195.html)。