文档首页/ Web3节点引擎服务 NES/ API参考/ API/ 专享版/ 节点管理/ 获取指定网络的所有节点
更新时间：2024-01-31 GMT+08:00
查看PDF
分享

获取指定网络的所有节点

功能介绍

获取指定网络的所有节点

URI

GET /v1/{project_id}/node-provider/networks/{network_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

最小长度：32

最大长度：32

network_id

是

String

网络ID

最小长度：36

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页查询起始位置

最小值：0

最大值：1000

limit

否

Integer

每页返回的条目数量

最小值：1

最大值：1000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

最小长度：1

最大长度：65535

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

nodes

Array of Node objects

节点列表信息

数组长度：0 - 100

count

Integer

总数

最小值：0

最大值：1000
表5 Node

参数

参数类型

描述

id

String

节点ID

最小长度：36

最大长度：45

node_type

String

节点类型（全节点:Full node或支持质押节点:Full node (Staking supported)）

最小长度：0

最大长度：100

flavor

String

节点规格

最小长度：0

最大长度：100

create_time

String

节点创建时间

最小长度：0

最大长度：100

status

Object

节点状态（Available,Unavailable,Creating,Upgrading）

eps_info

EpsInfo object

企业项目信息
表6 EpsInfo

参数

参数类型

描述

eps_id

String

企业项目ID

最小长度：0

最大长度：36

eps_name

String

企业项目名称

最小长度：0

最大长度：36

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

请求示例

无

响应示例

状态码： 200

请求成功

{
  "nodes" : [ {
    "id" : "468eda20-040b-11ee-877d-fa163e6c5c60",
    "node_type" : "Full node",
    "flavor" : {
      "cpu" : 4,
      "ram" : 16384,
      "description" : "Preferred",
      "azs" : [ "ap-southeast-3a" ]
    },
    "create_time" : "2023-06-06T09:41:37.000553+08:00",
    "status" : "Available",
    "eps_info" : {
      "eps_name" : "default",
      "eps_id" : 0
    }
  } ],
  "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

服务内部执行错误

错误码

请参见错误码。

父主题： 节点管理