文档首页/ Web3节点引擎服务 NES/ API参考/ API/ 专享版/ 节点监控/ 获取质押节点某段时间的状态信息
更新时间:2023-08-15 GMT+08:00

获取质押节点某段时间的状态信息

功能介绍

获取质押节点某段时间的状态信息(同步状态,Peer数趋势和区块高度趋势)

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:32

node_id

String

节点ID

最小长度:36

最大长度:45

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:1

最大长度:65535

表3 请求Body参数

参数

是否必选

参数类型

描述

time_range

String

查询区间的时间范围字符串,-1.-1.30(表示最近30分钟)

最小长度:0

最大长度:100

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

node_status

Array of BeaconNodeStatus objects

节点状态信息

数组长度:0 - 1000

count

Integer

节点数量

最小值:0

最大值:1000

表5 BeaconNodeStatus

参数

参数类型

描述

node_info

Array of NodeInfoResult objects

peer数量(inbound数量和outbound数量)

数组长度:0 - 1000

表6 NodeInfoResult

参数

参数类型

描述

timestamp

String

时间戳。

最小长度:0

最大长度:100

inbound

Integer

inbound peer数量

最小值:0

最大值:10000

outbound

Integer

outbound peer数量

最小值:0

最大值:10000

block_height

Integer

区块高度

最小值:0

最大值:2147483647

状态码: 400

表7 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:0

最大长度:65535

状态码: 401

表8 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:0

最大长度:65535

状态码: 500

表9 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:0

最大长度:65535

请求示例

{
  "time_range" : "-1.-1.30"
}

响应示例

状态码: 200

请求成功

{
  "node_status" : [ {
    "node_info" : [ {
      "timestamp" : "2023-05-09T10:00:24.775Z",
      "inbound" : 45,
      "outbound" : 32,
      "block_height" : 17222778
    } ]
  } ],
  "count" : 1
}

状态码: 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

服务内部执行错误

错误码

请参见错误码