ComponentHealth

ComponentHealth

JSON Example

{
    "name": "string",
    "status": "string",
    "readyReplica": 0,
    "totalReplica": 0,
    "reason": "string"
}

string

name

Required

Name of the component; component is the smallest unit of the health API. Each CategoryHealth category contains mutiple ServiceHealth, each ServiceHealth contains one or multiple ComponentHealth.

string

status

Required

Health status of a component, some component requires all pods are ready to be UP, some may not.

Possible values are : UP, PARTIALLY_UP, DOWN,

integer As int32 As int32

readyReplica

Required

Ready pod count.

integer As int32 As int32

totalReplica

Required

Totsl pod replica count.

string

reason

Optional

Reason of why this component has some issue, this filed is optional.

Deprecated

Availability

Deprecated in 4.2