REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

Get the Node Health Status

get

/console/admin/api/v2/dashboard/statistics/nodeHealth

Get the node health status (up or down).

Request

Supported Media Types

application/json

Query Parameters

nodeID: string

Node ID of a specific peer, orderer, proxy, or the console itself

Response

Supported Media Types

application/json

200 Response

Response with a series of up/down statuses by restriction

Root Schema : schema

Type: object

Show Source

data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsNodeHealth"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object StatsNodeHealth

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/StatsNodeHealth"
    }
}

Nested Schema : StatsNodeHealth

Type: object

Show Source

health: object health
nodeId: string
nodeType: string

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "health":{
            "type":"object",
            "properties":{
                "time":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : health

Type: object

Show Source

status: string
time: string

{
    "type":"object",
    "properties":{
        "time":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

400 Response

Invalid arguments

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Examples

This endpoint is used to get the health status (up or down) of specified nodes. The result is a JSON body which contains a series of up/down statuses for the specified nodes. If nodeID is not specified, the health of all nodes is returned. Time range is not supported for nodeHealth.

The following example shows how to generate the node health report by submitting a GET request on the REST resource using cURL.

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/nodeHealth?nodeID=<nodeID>"

For example,

curl -X GET -u myname@oracle.com:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/statistics/nodeHealth?nodeID=console"

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "data": [
    {
      "nodeId": "console",
      "nodeType": "console",
      "health": {
        "time": "Sun, 24 Feb 2021 06:41:48 GMT",
        "status": "up"
      }
    }
  ]
}