Skip to main content
Manja / Kubernetes

readCoreV1ComponentStatus

read the specified ComponentStatus

GET/api/v1/componentstatuses/{name}
Source
specs/api__v1_openapi.json
Revision
9a79c3bd90f7
Active snapshot
2a9112600697

Request

Path Parameters
name string
required

name of the ComponentStatus

Query Parameters
pretty string
optional

If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).

Responses

application/cbor io.k8s.api.core.v1.ComponentStatus object

OK

apiVersion string
optional

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[io.k8s.api.core.v1.ComponentCondition object]
optional

List of component conditions observed

items io.k8s.api.core.v1.ComponentCondition object

Information about the condition of a component.

error string
optional

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

message string
optional

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

status string
required

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

type string
required

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

kind string
optional

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
optional

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

Default: {}

application/json io.k8s.api.core.v1.ComponentStatus object

OK

apiVersion string
optional

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[io.k8s.api.core.v1.ComponentCondition object]
optional

List of component conditions observed

items io.k8s.api.core.v1.ComponentCondition object

Information about the condition of a component.

error string
optional

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

message string
optional

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

status string
required

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

type string
required

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

kind string
optional

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
optional

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

Default: {}

application/vnd.kubernetes.protobuf io.k8s.api.core.v1.ComponentStatus object

OK

apiVersion string
optional

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[io.k8s.api.core.v1.ComponentCondition object]
optional

List of component conditions observed

items io.k8s.api.core.v1.ComponentCondition object

Information about the condition of a component.

error string
optional

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

message string
optional

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

status string
required

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

type string
required

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

kind string
optional

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
optional

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

Default: {}

application/yaml io.k8s.api.core.v1.ComponentStatus object

OK

apiVersion string
optional

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[io.k8s.api.core.v1.ComponentCondition object]
optional

List of component conditions observed

items io.k8s.api.core.v1.ComponentCondition object

Information about the condition of a component.

error string
optional

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

message string
optional

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

status string
required

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

type string
required

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

kind string
optional

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
optional

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

Default: {}

Unauthorized