Search or ask Docker

HealthcheckResult

HealthcheckResult schema in Docker Engine API 1.57.

View Markdown

Schema

Type: object

HealthcheckResult stores information about a single run of a healthcheck probe
End

Type: string

Date and time at which this check ended in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which this check ended in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2020-01-04T10:45:21.364524523Z",
  "format": "dateTime",
  "type": "string"
}
ExitCode

Type: integer

ExitCode meanings:

  • 0 healthy
  • 1 unhealthy
  • 2 reserved (considered unhealthy)
  • other values: error running probe
All schema constraints and annotations
{
  "description": "ExitCode meanings:\n\n- `0` healthy\n- `1` unhealthy\n- `2` reserved (considered unhealthy)\n- other values: error running probe\n",
  "example": 0,
  "type": "integer"
}
Output

Type: string

Output from last check
All schema constraints and annotations
{
  "description": "Output from last check",
  "type": "string"
}
Start

Type: string

Date and time at which this check started in RFC 3339 format with nano-seconds.
All schema constraints and annotations
{
  "description": "Date and time at which this check started in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
  "example": "2020-01-04T10:44:24.496525531Z",
  "format": "date-time",
  "type": "string"
}
All schema constraints and annotations
{
  "description": "HealthcheckResult stores information about a single run of a healthcheck probe\n",
  "properties": {
    "End": {
      "description": "Date and time at which this check ended in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2020-01-04T10:45:21.364524523Z",
      "format": "dateTime",
      "type": "string"
    },
    "ExitCode": {
      "description": "ExitCode meanings:\n\n- `0` healthy\n- `1` unhealthy\n- `2` reserved (considered unhealthy)\n- other values: error running probe\n",
      "example": 0,
      "type": "integer"
    },
    "Output": {
      "description": "Output from last check",
      "type": "string"
    },
    "Start": {
      "description": "Date and time at which this check started in\n[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.\n",
      "example": "2020-01-04T10:44:24.496525531Z",
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object",
  "x-nullable": true
}