HealthCheckComponentDetail
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The health of one component. The description, error, duration, metadata and remediation hint are returned only to a caller allowed to view health check details; any other caller receives the name, category and status.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
component
required |
string | The component's name, as the by-name health route accepts it.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
category
required |
string | The category the component is grouped under, as the by-category health route accepts it.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
status
required |
HealthCheckStatus HealthCheckStatus | The component's current status.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
description
required |
string | What the check verifies.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
error
required |
string | The failure the check reported, when it did not pass.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
duration
required |
string (date-span) | How long the check took to run. Written as [-][d.]hh:mm:ss[.fffffff], for example
00:00:01.2500000; the seven-digit fraction of a second appears only when it is non-zero. Not
an ISO 8601 duration.
nullablepattern ^-?(\d{1,8}\.)?([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d{7})?$
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
metadata
required |
object | Additional values the check reported about the component.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||||
remediationHint
required |
string | A suggested next step when the component is not healthy.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.