Obtaining All Nodes on a Specified Network

Description

This API is used to obtain all nodes on a specified network.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. Minimum length: 32 characters Maximum length: 32 characters
network_id	Yes	String	Network ID. Minimum length: 36 characters Maximum length: 36 characters

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Start position of pagination query. Minimum value: 0 Maximum value: 1000
limit	No	Integer	Number of items returned on each page. Minimum value: 1 Maximum value: 1000

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Minimum length: 1 character Maximum length: 65,535 characters

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
nodes	Array of Node objects	Node list information.
count	Integer	Number of records. Minimum value: 0 Maximum value: 1000

**Table 5** Node
Parameter	Type	Description
id	String	Node ID. Minimum length: 36 characters Maximum length: 45 characters
node_type	String	Node type, which can be Full node or Full node (Staking supported). Minimum length: 0 characters Maximum length: 100 characters
flavor	String	Node specifications. Minimum length: 0 characters Maximum length: 100 characters
create_time	String	Time when the node was created. Minimum length: 0 characters Maximum length: 100 characters
status	Object	Node status, which can be Available, Unavailable, Creating, or Upgrading.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Status code: 500

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Status code. Minimum length: 3 characters Maximum length: 3 characters
error_code	String	Error code. Minimum length: 12 characters Maximum length: 12 characters
error_msg	String	Error message. Minimum length: 1 character Maximum length: 65,535 characters
message	String	Error details. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

None

Example Response

Status code: 200

Request successful.

{
  "nodes" : [ {
    "id" : "468eda20-040b-11ee-877d-fa163e6c5c60",
    "node_type" : "Full node",
    "flavor" : {
      "cpu" : 4,
      "ram" : 16384,
      "description" : "Preferred"
    },
    "create_time" : "2023-06-06T09:41:37.000553+08:00",
    "status" : "Available"
  } ],
  "count" : 1
}

Status code: 400

Verify parameter failed.

{
  "code" : 400,
  "error_code" : "BCS.03400001",
  "error_msg" : "Invalid request.",
  "message" : "unmarshal request data error"
}

Status code: 401

Authentication failed.

{
  "code" : 401,
  "error_code" : "BCS.03401001",
  "error_msg" : "Authorization failed.",
  "message" : "request token is not valid"
}

Status code: 500

Internal service error.

{
  "code" : 500,
  "error_code" : "BCS.03500001",
  "error_msg" : "Internal error.",
  "message" : "project [xxx] node [xxx] get service bearer user token error"
}