Querying a Node

Description

This API is used to query a node.

URI

GET /v1/{project_id}/node-provider/nodes/{node_id}

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

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
id	String	Node ID. Minimum length: 36 characters Maximum length: 45 characters
ws_address	String	WebSocket terminal address. Minimum length: 0 characters Maximum length: 100 characters
http_address	String	HTTP terminal address. Minimum length: 0 characters Maximum length: 100 characters
grpc_address	String	gRPC terminal address. Minimum length: 0 characters Maximum length: 100 characters
flavor	MachineFlavor object	Node specifications.
status	String	Node status, which can be Available, Unavailable, or Upgrading. Minimum length: 0 characters Maximum length: 100 characters
network_type	NetworkType object	Node network information.
node_type	String	Node type, which can be Full node or Full node (Staking supported). Minimum length: 0 characters Maximum length: 100 characters
high_availability	Boolean	Whether HA is available.
create_time	String	Time when the node was created. Minimum length: 0 characters Maximum length: 100 characters
mev_boost_address	String	MEV-Boost Address Minimum length: 0 characters Maximum length: 100 characters
mev_boost_status	Boolean	Whether MEV-Boost is normal.

**Table 4** MachineFlavor
Parameter	Type	Description
cpu	Integer	Number of CPU cores. Minimum value: 1 Maximum value: 1024
ram	Integer	Memory. Minimum value: 1 Maximum value: 1,048,576
description	String	Description, which can be Test, Preferred, Stable, or Powerful. Minimum length: 1 character Maximum length: 50 characters

**Table 5** NetworkType
Parameter	Type	Description
id	String	Network type ID. Minimum length: 0 characters Maximum length: 1000 characters
framework	String	Public blockchain name. Minimum length: 0 characters Maximum length: 1000 characters
name	String	Network name. Minimum length: 0 characters Maximum length: 1000 characters

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.

{
  "id" : "468eda20-040b-11ee-877d-fa163e6c5c60",
  "ws_address" : "ws://100.100.100.100",
  "http_address" : "http://100.100.100.100",
  "grpc_address" : "100.100.100.100:30002",
  "flavor" : {
    "cpu" : 2,
    "ram" : 8196,
    "description" : "Preferred"
  },
  "status" : "Available",
  "network_type" : {
    "id" : "79d0f3b9-8ce1-11ed-8398-0242a9fe1e02",
    "framework" : "Ethereum",
    "name" : "Goerli"
  },
  "node_type" : "Full node",
  "high_availability" : false,
  "create_time" : "2023-06-06T09:41:37.000553+08:00",
  "mev_boost_address" : "123.123.123.123:1234",
  "mev_boost_status" : true
}

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"
}