ComponentHealth

Properties

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.


integer as int32
readyReplica Required

Ready pod count.


string
reason Optional

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


string
status Required

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

Possible values are: UPPARTIALLY_UPDOWN


integer as int32
totalReplica Required

Totsl pod replica count.

JSON Example

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

Feedback

Was this page helpful?