14.3. ComponentStatus [v1]
- 描述
- ComponentStatus （和 ComponentStatusList）包含集群验证信息。弃用：此 API 在 v1.19+ 中弃用
- 类型
-
对象
14.3.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| 观察到的组件条件列表 |
|
|
| 有关组件条件的信息。 |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
14.3.1.1. .conditions
- 描述
- 观察到的组件条件列表
- 类型
-
array
14.3.1.2. .conditions[]
- 描述
- 有关组件条件的信息。
- 类型
-
object - 必填
-
type -
status
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 组件的错误代码。例如，健康检查错误代码。 |
|
|
| 有关组件条件的信息。例如，关于健康检查的信息。 |
|
|
| 组件条件的状态。"Healthy": "True", "False", 或 "Unknown" 的有效值。 |
|
|
| 组件的条件类型。有效值："Healthy" |
14.3.2. API 端点
可用的 API 端点如下：
/api/v1/componentstatuses-
GET: 列出 kind ComponentStatus 的对象
-
/api/v1/componentstatuses/{name}-
GET: 读取指定的 ComponentStatus
-
14.3.2.1. /api/v1/componentstatuses
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。 |
|
|
| 从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，则必须重启其列表，而无需 continue 字段。否则，客户端可能会发送另一个带有 410 错误的令牌的列表请求，服务器将使用从下一个密钥开始的列表进行响应，但从最新的快照开始，从上一个列表结果（创建、修改或删除）后，创建、修改或删除第一个列表请求将包含在响应中，只要它们的键位于"下一密钥"后。 当监视为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值开始监视，而不错过任何修改。 |
|
|
| 用于按字段限制返回对象列表的选择器。默认为任何内容。 |
|
|
| 一个选择器，用于按标签限制返回的对象列表。默认为任何内容。 |
|
|
| limit 是列表调用返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的 'continue' 字段设置为可用于同一初始查询的值，以检索下一个结果集合。如果过滤了所有请求的对象，设置限制可能会小于请求的项目数量（最多零项），并且客户端应该只使用 continue 字段的存在来确定是否有可用的结果。服务器可能选择不支持 limit 参数，并将返回所有可用结果。如果指定了 limit，并且 continue 字段为空，客户端可能会假设没有更多结果可用。如果 watch 为 true，则不支持此字段。 服务器保证，在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用时返回的对象将相同，即在发出第一个请求后没有创建、修改或删除的对象。这有时被称为一致的快照，并确保使用限制的客户端接收大量结果的较小的块可以确保它们可以看到所有可能的对象。如果在块列表列表期间更新对象，则返回第一个列表结果时存在的对象版本。 |
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
|
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列表调用。强烈建议您为设置 resourceVersion 的列表调用设置 resourceVersionMatch，详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
|
| 'sendInitialEvents=true' 可以与 'watch=true' 一起设置。在这种情况下，监视流将以 synthetic 事件开头，以生成集合中对象的当前状态。发送完所有此类事件后，将发送一个合成"Bookmark"事件。书签将报告与一组对象对应的 ResourceVersion (RV)，并标有 '"k8s.io/initial-events-end": "true"' 注解。之后，监视流会照常进行，将与更改对应的监控事件(subsequent to the RV)发送到被监视的对象。 当设置了 'sendInitialEvents' 选项时，我们还需要设置 'resourceVersionMatch' 选项。监视请求的语义如下： - 'resourceVersionMatch' = NotOlderThan 解释为 "data at the provided as the provided as the provided 'resourceVersion'"，当状态同步到 'resourceVersion' 时，书签事件至少作为 ListOptions 提供的 "resourceVersion" 提供。如果未设置 'resourceVersion'，则会将其解释为 "consistent read"，并且当状态在请求开始处理时至少同步时，会发送书签事件。- 'resourceVersionMatch' 设置为任何其他值或取消设置 Invalid 错误。 如果 'resourceVersion="" 或 'resourceVersion="0"' （用于向后兼容的原因）和 false，则默认为 true。 |
|
|
| list/watch 调用的超时。这限制了调用的持续时间，而不考虑任何活动或不活跃。 |
|
|
| 观察对上述资源的更改，并将其恢复为添加、更新和删除通知的流。指定 resourceVersion。 |
- HTTP 方法
-
GET - 描述
- 列出 kind componentStatus 的对象
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
14.3.2.2. /api/v1/componentstatuses/{name}
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 组件状态的名称 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 如果为 'true'，则输出会经过 pretty print 处理。 |
- HTTP 方法
-
GET - 描述
- 读取指定的 componentStatus
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空 |
