Jump to

• Request
• Response

Get the Node Health Status

get

/console/admin/api/v1.1/dashboard/Statistics/nodeHealth

Get the node health status (up or down).

Request

Supported Media Types

• application/json

Query Parameters

• nodeID(optional): string
  Node ID of a specific peer, orderer, proxy, or the console itself

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with a series of up/down statuses by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): 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(optional): object health
• nodeId(optional): string
• nodeType(optional): 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(optional): string
• time(optional): string

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

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

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

Back to Top