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

Get the Node Usage Related Metrics

get

/console/admin/api/v2/dashboard/statistics/nodeRes

Get the node usage related metrics: CPU, memory, disk usage.

Request

Supported Media Types

application/json

Query Parameters

nodeID: string

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

Response

Supported Media Types

application/json

200 Response

Response with a series of usage records by restriction

Root Schema : schema

Type: object

Show Source

data: array data

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

Nested Schema : data

Type: array

Show Source

Array of: object StatsNodeRes

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

Nested Schema : StatsNodeRes

Type: object

Show Source

nodeId: string
nodeType: string
resUsage: object resUsage

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "resUsage":{
            "type":"object",
            "properties":{
                "startTime":{
                    "type":"string"
                },
                "endTime":{
                    "type":"string"
                },
                "cpu":{
                    "type":"number"
                },
                "memory":{
                    "type":"number"
                },
                "disk":{
                    "type":"number"
                }
            }
        }
    }
}

Nested Schema : resUsage

Type: object

Show Source

cpu: number
disk: number
endTime: string
memory: number
startTime: string

{
    "type":"object",
    "properties":{
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "cpu":{
            "type":"number"
        },
        "memory":{
            "type":"number"
        },
        "disk":{
            "type":"number"
        }
    }
}

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 node usage related metrics such as CPU, memory, and disk usage percentages, reflecting the health metrics you can see on the console. The result is a JSON body which contains a series of usage records for the specified nodes.

If nodeID is not specified, it returns this information for all nodes in the instance.

The following example shows how to generate the node metrics 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/nodeRes?nodeID=<nodeID>"

For example,

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

Example of the Response Body

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

{
  "data": [
    {
      "nodeId": "orderer0",
      "nodeType": "orderer",
      "resUsage": {
        "cpu": 0.76,
        "memory": 0.656,
        "disk": 2.772
      }
    }
  ]
}

This is an example of the output for the node orderer0. The resource usage disk : 2.772 means that orderer0 occupies 2.772% of total disk storage (/u01). Note that this does not mean that there is 97.228% (100% - 2.772%) free space available for orderer0; disk storage (/u01) is shared by all the orderers and peers running on the VM.