[zh-cn] resync component-status-v1.md

This commit is contained in:
windsonsea 2022-07-01 11:16:39 +08:00
parent d120e696f4
commit bd83516ff1
1 changed files with 225 additions and 0 deletions

View File

@ -0,0 +1,225 @@
---
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ComponentStatus"
content_type: "api_reference"
description: "ComponentStatus和 ComponentStatusList保存集群检验信息。"
title: "ComponentStatus"
weight: 10
---
<!--
api_metadata:
apiVersion: "v1"
import: "k8s.io/api/core/v1"
kind: "ComponentStatus"
content_type: "api_reference"
description: "ComponentStatus (and ComponentStatusList) holds the cluster validation info."
title: "ComponentStatus"
weight: 10
auto_generated: true
-->
`apiVersion: v1`
`import "k8s.io/api/core/v1"`
## ComponentStatus {#ComponentStatus}
<!--
ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
-->
ComponentStatus和 ComponentStatusList保存集群检验信息。
已废弃:该 API 在 v1.19 及更高版本中废弃。
<hr>
- **apiVersion**: v1
- **kind**: ComponentStatus
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
<!--
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
-->
标准的对象元数据。更多信息:
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
<a name="ComponentCondition"></a>
*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".
-->
**补丁策略:基于键 `type` 合并**
观测到的组件状况的列表。
<a name="ComponentCondition"></a>
**组件状况相关信息。**
- **conditions.status** (string),必需
组件状况的状态。“Healthy” 的有效值为“True”、“False” 或 “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.
-->
- **conditions.type** (string),必需
组件状况的类型。有效值“Healthy”
- **conditions.error** (string)
组件状况的错误码。例如,一个健康检查错误码。
- **conditions.message** (string)
组件状况相关消息。例如,有关健康检查的信息。
## ComponentStatusList {#ComponentStatusList}
<!--
Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+
-->
作为 ComponentStatus 对象列表,所有组件状况的状态。
已废弃:该 API 在 v1.19 及更高版本中废弃。
<hr>
- **apiVersion**: v1
- **kind**: ComponentStatusList
<!--
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
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</a>), required
List of ComponentStatus objects.
-->
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
标准的对象元数据。更多信息:
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</a>),必需
ComponentStatus 对象的列表。
<!--
## Operations {#Operations}
<hr>
### `get` read the specified ComponentStatus
#### HTTP Request
-->
## 操作 {#Operations}
<hr>
### `get` 读取指定的 ComponentStatus
#### HTTP 请求
GET /api/v1/componentstatuses/{name}
<!--
#### Parameters
- **name** (*in path*): string, required
name of the ComponentStatus
- **pretty** (*in query*): string
-->
#### 参数
- **name** (**路径参数**): string必需
ComponentStatus 的名称
- **pretty** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
<!--
#### Response
-->
#### 响应
200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus</a>): OK
401: Unauthorized
<!--
### `list` list objects of kind ComponentStatus
#### HTTP Request
-->
### `list` 列出 ComponentStatus 类别的对象
#### HTTP 请求
GET /api/v1/componentstatuses
<!--
#### Parameters
- **allowWatchBookmarks** (*in query*): boolean
- **continue** (*in query*): string
- **fieldSelector** (*in query*): string
- **labelSelector** (*in query*): string
- **limit** (*in query*): integer
- **pretty** (*in query*): string
- **resourceVersion** (*in query*): string
- **resourceVersionMatch** (*in query*): string
- **timeoutSeconds** (*in query*): integer
- **watch** (*in query*): boolean
-->
#### 参数
- **allowWatchBookmarks** (**查询参数**): boolean
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
- **continue** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
- **fieldSelector** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
- **labelSelector** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
- **limit** (**查询参数**): integer
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
- **pretty** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
- **resourceVersion** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
- **resourceVersionMatch** (**查询参数**): string
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
- **timeoutSeconds** (**查询参数**): integer
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
- **watch** (**查询参数**): boolean
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
<!--
#### Response
-->
#### 响应
200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatusList" >}}">ComponentStatusList</a>): OK
401: Unauthorized