本文导读

展开导读

文档首页/ 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	服务内部执行错误

错误码

请参见错误码。

父主题： 节点管理

上一篇：获取所有规格

下一篇：创建节点

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

获取指定网络的所有节点

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

意见反馈

文档内容是否对您有帮助？

文档反馈