Chapter 4. ComponentStatus [v1]

Description: ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
Type: object

4.1. Specification

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`conditions`	`array`	List of component conditions observed
`conditions[]`	`object`	Information about the condition of a component.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

4.1.1. .conditions

Description: List of component conditions observed
Type: array

4.1.2. .conditions[]

Description

Information about the condition of a component.

Type

object

Required

type
status

Property	Type	Description
`error`	`string`	Condition error code for a component. For example, a health check error code.
`message`	`string`	Message about the condition for a component. For example, information about a health check.
`status`	`string`	Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
`type`	`string`	Type of condition for a component. Valid value: "Healthy"

4.2. API endpoints

The following API endpoints are available:

/api/v1/componentstatuses
- GET: list objects of kind ComponentStatus
/api/v1/componentstatuses/{name}
- GET: read the specified ComponentStatus

4.2.1. /api/v1/componentstatuses

HTTP method: GET
Description: list objects of kind ComponentStatus

Table 4.1. HTTP responses
HTTP code	Reponse body
200 - OK	`ComponentStatusList` schema
401 - Unauthorized	Empty

4.2.2. /api/v1/componentstatuses/{name}

Table 4.2. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the ComponentStatus

HTTP method: GET
Description: read the specified ComponentStatus

Table 4.3. HTTP responses
HTTP code	Reponse body
200 - OK	`ComponentStatus` schema
401 - Unauthorized	Empty

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.