文档首页/ 区块链服务 BCS/ API参考/ API(Hyperledger Fabric增强版)/ BCS监控/ 查询BCS组织监控数据列表
更新时间：2023-04-24 GMT+08:00
查看PDF
分享

查询BCS组织监控数据列表

功能介绍

该接口用于查询BCS组织的监控数据列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

blockchain_id

是

String

区块链服务id 目前不支持IEF实例

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

参数

是否必选

参数类型

描述

type

是

String

实体类型，[可选值如下: org(节点组织), plugin(插件)] 默认为org

entity_name

否

String

具体实体的名称

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

metrics

Array of EntityMetricList objects

指标对象列表。
表5 EntityMetricList

参数

参数类型

描述

dimensions

Array of Dimension objects

指标对象列表。

values

Array of EntityMetricListItem objects

监控数据列表项目。
表6 Dimension

参数

参数类型

描述

name

String

维度名称。

value

String

维度取值。
表7 EntityMetricListItem

参数

参数类型

描述

cpuUsage

String

cpu使用率

diskReadRate

String

磁盘读取速率

diskWriteRate

String

磁盘写入速率

memUsage

String

物理内存使用率

recvBytesRate

String

下行BPs

sendBytesRate

String

上行BPs

filesystemUsage

String

文件系统使用率

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 403

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

状态码： 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：8

最大长度：36

error_msg

String

错误描述

最小长度：2

最大长度：512

请求示例

{
  "type" : "org",
  "entity_name" : "baas-agent"
}

响应示例

状态码： 200

Ok

{
  "metrics" : [ {
    "dimensions" : [ {
      "name" : "cluster",
      "value" : "abc"
    } ],
    "values" : [ {
      "cpuUsage" : 0.175,
      "diskReadRate" : 0,
      "diskWriteRate" : 0,
      "memUsage" : 1.252,
      "recvBytesRate" : 1703.617,
      "sendBytesRate" : 2438.85,
      "filesystemUsage" : 9.344
    } ]
  } ]
}

状态码： 400

Bad Request

{
  "error_code" : "BCS.4004024",
  "error_msg" : "invalid org name input"
}

状态码： 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监控