文档首页/ Web3节点引擎服务/ API参考/ API/ 专享版/ 节点监控/ 获取节点监控信息
更新时间：2023-08-15 GMT+08:00
查看PDF

获取节点监控信息

功能介绍

主要包括节点CPU使用率、内存使用率、网络流量（上行、下行）、存储用量和磁盘读写

URI

POST /v1/{project_id}/node-provider/nodes/{node_id}/metrics

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：32

最大长度：32

node_id

是

String

节点ID

最小长度：36

最大长度：45

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

最小长度：1

最大长度：65535
表3 请求Body参数

参数

是否必选

参数类型

描述

metric_names

否

Array of strings

指标列表 取值范围 cpuUsage：CPU使用率 diskUsedRate：磁盘使用率 memUsedRate：物理内存使用率 sendBytesRate：上行Bps recvBytesRate：下行Bps cpuCoreLimit：CPU内核总量 cpuCoreUsed：CPU内核占用 totalMem：物理内存总量 freeMem：可用物理内存 diskCapacity：磁盘空间容量 diskAvailableCapacity：可用磁盘空间 默认值：前5项

数组长度：0 - 1000

period

是

Integer

监控数据粒度,取值范围（枚举）：60（表示粒度为1分钟），300（表示粒度为5分钟）

最小值：0

最大值：86400

timerange

是

String

查询时间范围，-1.-1.60(表示最近60分钟) startTimeInMillis.endTimeInMillis.durationInMinutes

最小长度：0

最大长度：100

statistics

是

Array of strings

统计方式，取值范围 maximum，minimum，sum，average，sampleCount

数组长度：0 - 1000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

metrics

Array of MetricItemResultAPI objects

指标对象列表。

数组长度：0 - 1000
表5 MetricItemResultAPI

参数

参数类型

描述

metric

MetricDemision object

指标描述信息

dataPoints

Array of MetricDataPoints objects

监控数据信息

数组长度：0 - 1000
表6 MetricDemision

参数

参数类型

描述

namespace

String

命名空间

最小长度：1

最大长度：65535

metricName

String

指标名称

最小长度：1

最大长度：65535

dimensions

Array of Dimension objects

维度列表

数组长度：0 - 1000
表7 Dimension

参数

参数类型

描述

name

String

维度名称

最小长度：1

最大长度：65535

value

String

维度取值

最小长度：1

最大长度：65535
表8 MetricDataPoints

参数

参数类型

描述

timestamp

String

时间戳。

最小长度：0

最大长度：100

unit

String

指标单位。

最小长度：1

最大长度：65535

statistics

Array of StatisticValue objects

统计方式。

数组长度：0 - 1000
表9 StatisticValue

参数

参数类型

描述

statistic

String

统计方式

最小长度：1

最大长度：65535

value

Double

统计结果。

最小值：0

最大值：2147483647

状态码： 400

表10 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

状态码： 401

表11 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

状态码： 500

表12 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

请求示例

{
  "metric_names" : [ "cpuUsage" ],
  "period" : 300,
  "timerange" : "-1.-1.60",
  "statistics" : [ "maximum" ]
}

响应示例

状态码： 200

请求成功

{
  "metrics" : [ {
    "metric" : {
      "namespace" : "123",
      "metricName" : "cpuUsage",
      "dimensions" : [ {
        "name" : "nodeIP",
        "value" : "192.168.0.1"
      } ]
    },
    "dataPoints" : [ {
      "timestamp" : 1686059700000,
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "average",
        "value" : 20
      } ]
    } ]
  } ]
}

状态码： 400

请求参数校验不通过

{
  "code" : 400,
  "error_code" : "BCS.03400001",
  "error_msg" : "Invalid request.",
  "message" : "unmarshal request data error"
}

状态码： 401

鉴权失败

{
  "code" : 401,
  "error_code" : "BCS.03401001",
  "error_msg" : "Authorization failed.",
  "message" : "request token is not valid"
}

状态码： 500

服务内部执行错误

{
  "code" : 500,
  "error_code" : "BCS.03500001",
  "error_msg" : "Internal error.",
  "message" : "project [xxx] node [xxx] get service bearer user token error"
}

状态码

状态码

描述

200

请求成功

400

请求参数校验不通过

401

鉴权失败

500

服务内部执行错误

错误码

请参见错误码。

父主题： 节点监控