website/content/en/docs/reference/kubernetes-api/cluster-resources/component-status-v1.md

api_metadata	content_type	description	title	weight	auto_generated
apiVersion import kind v1 k8s.io/api/core/v1 ComponentStatus	api_reference	ComponentStatus (and ComponentStatusList) holds the cluster validation info.	ComponentStatus	10	true

apiVersion: v1

import "k8s.io/api/core/v1"

ComponentStatus

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

---

• apiVersion: v1

• kind: ComponentStatus

• metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

  Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• conditions ([]ComponentCondition)

  Patch strategy: merge on key type

  List of component conditions observed

  Information about the condition of a component.

  • conditions.status (string), required

    Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".

  • conditions.type (string), required

    Type of condition for a component. Valid value: "Healthy"

  • conditions.error (string)

    Condition error code for a component. For example, a health check error code.

  • conditions.message (string)

    Message about the condition for a component. For example, information about a health check.

ComponentStatusList

Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

---

• apiVersion: v1

• kind: ComponentStatusList

• metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

  Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

• items ([]<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus), required

  List of ComponentStatus objects.

Operations

---

get read the specified ComponentStatus

HTTP Request

GET /api/v1/componentstatuses/{name}

Parameters

• name (in path): string, required

  name of the ComponentStatus

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

Response

200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus): OK

401: Unauthorized

list list objects of kind ComponentStatus

HTTP Request

GET /api/v1/componentstatuses

Parameters

• allowWatchBookmarks (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks

• continue (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue

• fieldSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector

• labelSelector (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector

• limit (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit

• pretty (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

• resourceVersion (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion

• resourceVersionMatch (in query): string

  <a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch

• timeoutSeconds (in query): integer

  <a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

• watch (in query): boolean

  <a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

Response

200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatusList" >}}">ComponentStatusList): OK

401: Unauthorized