v1.ComponentStatus

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

You are viewing documentation for a release that is no longer supported. The latest supported version of version 3 is [3.11]. For the most recent version 4, see [4]

Description

ComponentStatus (and ComponentStatusList) holds the cluster validation info.

Object Schema

Expand or mouse-over a field for more information about it.

  1. apiVersion:
  2. conditions:
  3. - error:
  4. message:
  5. status:
  6. type:
  7. kind:
  8. metadata:
  9. annotations:
  10. [string]:
  11. clusterName:
  12. creationTimestamp:
  13. deletionGracePeriodSeconds:
  14. deletionTimestamp:
  15. finalizers:
  16. - [string]:
  17. generateName:
  18. generation:
  19. initializers:
  20. pending:
  21. - name:
  22. result:
  23. apiVersion:
  24. code:
  25. details:
  26. causes:
  27. - field:
  28. message:
  29. reason:
  30. group:
  31. kind:
  32. name:
  33. retryAfterSeconds:
  34. uid:
  35. kind:
  36. message:
  37. metadata:
  38. resourceVersion:
  39. selfLink:
  40. reason:
  41. status:
  42. labels:
  43. [string]:
  44. name:
  45. namespace:
  46. ownerReferences:
  47. - apiVersion:
  48. blockOwnerDeletion:
  49. controller:
  50. kind:
  51. name:
  52. uid:
  53. resourceVersion:
  54. selfLink:
  55. uid:

Operations

Get a ComponentStatus

Read the specified ComponentStatus

HTTP request

  1. GET /api/v1/componentstatuses/$NAME HTTP/1.1
  2. Authorization: Bearer $TOKEN
  3. Accept: application/json
  4. Connection: close

Curl request

  1. $ curl -k \
  2. -H "Authorization: Bearer $TOKEN" \
  3. -H 'Accept: application/json' \
  4. https://$ENDPOINT/api/v1/componentstatuses/$NAME

Path parameters

ParameterDescription

name

name of the ComponentStatus

Query parameters

ParameterDescription

pretty

If ‘true’, then the output is pretty printed.

Responses

HTTP CodeSchema

200 OK

v1.ComponentStatus

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

Get all ComponentStatuses

List objects of kind ComponentStatus

HTTP request

  1. GET /api/v1/componentstatuses HTTP/1.1
  2. Authorization: Bearer $TOKEN
  3. Accept: application/json
  4. Connection: close

Curl request

  1. $ curl -k \
  2. -H "Authorization: Bearer $TOKEN" \
  3. -H 'Accept: application/json' \
  4. https://$ENDPOINT/api/v1/componentstatuses

Query parameters

ParameterDescription

fieldSelector

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

If true, partially initialized resources are included in the response.

labelSelector

A selector to restrict the list of returned objects by their labels. Defaults to everything.

pretty

If ‘true’, then the output is pretty printed.

resourceVersion

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it’s 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

Timeout for the list/watch call.

watch

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

HTTP CodeSchema

200 OK

v1.ComponentStatusList

401 Unauthorized

Consumes

  • */*

Produces

  • application/json

  • application/yaml

  • application/vnd.kubernetes.protobuf

  • application/json;stream=watch

  • application/vnd.kubernetes.protobuf;stream=watch