文档首页/ Web3节点引擎服务 NES/ API参考/ API/ 专享版/ 节点监控/ 获取节点某段时间的API调用信息
更新时间：2024-01-31 GMT+08:00
查看PDF
分享

获取节点某段时间的API调用信息

功能介绍

获取节点某段时间的API调用量

URI

POST /v1/{project_id}/node-provider/nodes/{node_id}/api-statistics

表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.5(表示最近5分钟)

最小长度：0

最大长度：100

period

是

Integer

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

最小值：0

最大值：86400

statistics

否

Array of strings

统计方式

最小长度：0

最大长度：100

数组长度：0 - 1000

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

top

Array of TopMethodResult objects

top5请求量列表

数组长度：0 - 1000

data

Array of MethodResult objects

API调用数据

数组长度：0 - 1000
表5 TopMethodResult

参数

参数类型

描述

method

String

方法名

最小长度：0

最大长度：100

count

Long

调用量

最小值：0

最大值：2147483648
表6 MethodResult

参数

参数类型

描述

timestamp

String

时间戳。

最小长度：0

最大长度：100

count

Long

调用量

最小值：0

最大值：2147483648

状态码： 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.5",
  "period" : 300,
  "statistics" : [ "average" ]
}

响应示例

状态码： 200

请求成功

{
  "top" : [ {
    "method" : "geth",
    "count" : 10
  } ],
  "data" : [ {
    "timestamp" : "2023-06-06T22:00:00+08:00",
    "count" : 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

服务内部执行错误

错误码

请参见错误码。

父主题： 节点监控