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

获取总览信息

功能介绍

获取当前用户总览信息

URI

GET /v1/{project_id}/node-provider/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：32

最大长度：32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

最小长度：1

最大长度：65535

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

chain

Integer

网络类型

最小值：0

最大值：2147483647

node

Integer

节点数量

最小值：0

最大值：2147483647

full_node

Integer

全节点数量

最小值：0

最大值：2147483647

staking

Integer

支持质押节点数量

最小值：0

最大值：2147483647

call

Integer

总调用数量

最小值：0

最大值：2147483647

alarm

Integer

告警数量

最小值：0

最大值：2147483647

状态码： 400

表4 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

状态码： 401

表5 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

状态码： 500

表6 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度：3

最大长度：3

error_code

String

错误码

最小长度：12

最大长度：12

error_msg

String

错误信息

最小长度：1

最大长度：65535

message

String

错误详细信息

最小长度：0

最大长度：65535

请求示例

无

响应示例

状态码： 200

请求成功

{
  "chain" : 1,
  "node" : 2,
  "full_node" : 1,
  "staking" : 1,
  "call" : 10000,
  "alarm" : 10
}

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

服务内部执行错误

错误码

请参见错误码。

父主题： 节点管理