文档首页/ 区块链服务 BCS/ API参考/ Hyperledger Fabric增强版管理/ API(Hyperledger Fabric增强版)/ BCS监控/ 查询服务实例监控数据 - ListBcsMetric
更新时间：2025-11-12 GMT+08:00
查看PDF
分享

查询服务实例监控数据 - ListBcsMetric

功能介绍

该接口用于查询BCS服务的监控数据，可以指定相应的指标名称。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v2/{project_id}/blockchains/{blockchain_id}/metric/list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户从IAM申请到的projectid，一般为32位字符串。

blockchain_id

是

String

区块链服务id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取。
表3 请求Body参数

参数

是否必选

参数类型

描述

metric_names

否

Array of strings

指标列表 取值范围

cpuUsage：CPU使用率

diskUsedRate：磁盘使用率

memUsedRate：物理内存使用率

sendBytesRate：上行Bps

recvBytesRate：下行Bps

cpuCoreLimit：CPU内核总量

cpuCoreUsed：CPU内核占用

totalMem：物理内存总量

freeMem：可用物理内存

diskCapacity：磁盘空间容量

diskAvailableCapacity：可用磁盘空间

默认值：前5项

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

metrics

Array of MetricItemResultAPI objects

指标对象列表。
表5 MetricItemResultAPI

参数

参数类型

描述

metric

MetricDemision object

指标描述信息

dataPoints

Array of MetricDataPoints objects

监控数据信息
表6 MetricDemision

参数

参数类型

描述

namespace

String

命名空间

metricName

String

指标名称

dimensions

Array of Dimension objects

维度列表
表7 Dimension

参数

参数类型

描述

name

String

维度名称。

value

String

维度取值。
表8 MetricDataPoints

参数

参数类型

描述

timestamp

Long

时间戳。

unit

String

指标单位。

statistics

Array of StatisticValue objects

统计方式。
表9 StatisticValue

参数

参数类型

描述

statistic

String

统计方式。

value

Double

统计结果。

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：500

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询CPU和DISK使用监控

{
  "metric_names" : [ "cpuUsage", "diskUsedRate" ]
}

响应示例

状态码：200

Ok

{
  "metrics" : [ {
    "metric" : {
      "namespace" : "abc",
      "metricName" : "def",
      "dimensions" : [ {
        "name" : "ghi",
        "value" : "lmn"
      } ]
    },
    "dataPoints" : [ {
      "timestamp" : "1467892800000",
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "maximum",
        "value" : "23"
      } ]
    } ]
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "BCS.4001108",
  "error_msg" : "metric names is wrong"
}

状态码：401

Unauthorized

{
  "error_code" : "BCS.4010401",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error_code" : "BCS.4030403",
  "error_msg" : "No permissions to request this method"
}

状态码：404

Not Found

{
  "error_code" : "BCS.4040404",
  "error_msg" : "Not Found:the url is not found"
}

状态码：500

InternalServerError

{
  "error_code" : "BCS.5000500",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

InternalServerError

错误码

请参见错误码。

父主题： BCS监控