Skip to content

Commit e23d903

Browse files
authored
Merge pull request #34744 from windsonsea/component
[zh-cn] resync component-status-v1.md
2 parents a408b31 + bd83516 commit e23d903

File tree

1 file changed

+225
-0
lines changed

1 file changed

+225
-0
lines changed
Lines changed: 225 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,225 @@
1+
---
2+
api_metadata:
3+
apiVersion: "v1"
4+
import: "k8s.io/api/core/v1"
5+
kind: "ComponentStatus"
6+
content_type: "api_reference"
7+
description: "ComponentStatus(和 ComponentStatusList)保存集群检验信息。"
8+
title: "ComponentStatus"
9+
weight: 10
10+
---
11+
<!--
12+
api_metadata:
13+
apiVersion: "v1"
14+
import: "k8s.io/api/core/v1"
15+
kind: "ComponentStatus"
16+
content_type: "api_reference"
17+
description: "ComponentStatus (and ComponentStatusList) holds the cluster validation info."
18+
title: "ComponentStatus"
19+
weight: 10
20+
auto_generated: true
21+
-->
22+
23+
`apiVersion: v1`
24+
25+
`import "k8s.io/api/core/v1"`
26+
27+
## ComponentStatus {#ComponentStatus}
28+
<!--
29+
ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+
30+
-->
31+
ComponentStatus(和 ComponentStatusList)保存集群检验信息。
32+
已废弃:该 API 在 v1.19 及更高版本中废弃。
33+
34+
<hr>
35+
36+
- **apiVersion**: v1
37+
38+
- **kind**: ComponentStatus
39+
40+
- **metadata** (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta</a>)
41+
42+
<!--
43+
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
44+
-->
45+
标准的对象元数据。更多信息:
46+
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
47+
48+
- **conditions** ([]ComponentCondition)
49+
50+
<!--
51+
*Patch strategy: merge on key `type`*
52+
List of component conditions observed
53+
54+
<a name="ComponentCondition"></a>
55+
*Information about the condition of a component.*
56+
57+
- **conditions.status** (string), required
58+
Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
59+
-->
60+
**补丁策略:基于键 `type` 合并**
61+
62+
观测到的组件状况的列表。
63+
64+
<a name="ComponentCondition"></a>
65+
**组件状况相关信息。**
66+
67+
- **conditions.status** (string),必需
68+
69+
组件状况的状态。“Healthy” 的有效值为:“True”、“False” 或 “Unknown”。
70+
71+
<!--
72+
- **conditions.type** (string), required
73+
Type of condition for a component. Valid value: "Healthy"
74+
75+
- **conditions.error** (string)
76+
Condition error code for a component. For example, a health check error code.
77+
78+
- **conditions.message** (string)
79+
Message about the condition for a component. For example, information about a health check.
80+
-->
81+
- **conditions.type** (string),必需
82+
83+
组件状况的类型。有效值:“Healthy”
84+
85+
- **conditions.error** (string)
86+
87+
组件状况的错误码。例如,一个健康检查错误码。
88+
89+
- **conditions.message** (string)
90+
91+
组件状况相关消息。例如,有关健康检查的信息。
92+
93+
## ComponentStatusList {#ComponentStatusList}
94+
<!--
95+
Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+
96+
-->
97+
作为 ComponentStatus 对象列表,所有组件状况的状态。
98+
已废弃:该 API 在 v1.19 及更高版本中废弃。
99+
<hr>
100+
101+
- **apiVersion**: v1
102+
103+
- **kind**: ComponentStatusList
104+
105+
<!--
106+
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
107+
Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
108+
109+
- **items** ([]<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus</a>), required
110+
List of ComponentStatus objects.
111+
-->
112+
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
113+
114+
标准的对象元数据。更多信息:
115+
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
116+
117+
- **items** ([]<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus</a>),必需
118+
119+
ComponentStatus 对象的列表。
120+
121+
<!--
122+
## Operations {#Operations}
123+
<hr>
124+
### `get` read the specified ComponentStatus
125+
#### HTTP Request
126+
-->
127+
## 操作 {#Operations}
128+
<hr>
129+
130+
### `get` 读取指定的 ComponentStatus
131+
#### HTTP 请求
132+
GET /api/v1/componentstatuses/{name}
133+
134+
<!--
135+
#### Parameters
136+
- **name** (*in path*): string, required
137+
name of the ComponentStatus
138+
- **pretty** (*in query*): string
139+
-->
140+
#### 参数
141+
- **name** (**路径参数**): string,必需
142+
143+
ComponentStatus 的名称
144+
145+
- **pretty** (**查询参数**): string
146+
147+
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
148+
149+
<!--
150+
#### Response
151+
-->
152+
#### 响应
153+
200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatus" >}}">ComponentStatus</a>): OK
154+
155+
401: Unauthorized
156+
157+
<!--
158+
### `list` list objects of kind ComponentStatus
159+
#### HTTP Request
160+
-->
161+
### `list` 列出 ComponentStatus 类别的对象
162+
#### HTTP 请求
163+
GET /api/v1/componentstatuses
164+
165+
<!--
166+
#### Parameters
167+
- **allowWatchBookmarks** (*in query*): boolean
168+
- **continue** (*in query*): string
169+
- **fieldSelector** (*in query*): string
170+
- **labelSelector** (*in query*): string
171+
- **limit** (*in query*): integer
172+
- **pretty** (*in query*): string
173+
- **resourceVersion** (*in query*): string
174+
- **resourceVersionMatch** (*in query*): string
175+
- **timeoutSeconds** (*in query*): integer
176+
- **watch** (*in query*): boolean
177+
-->
178+
#### 参数
179+
- **allowWatchBookmarks** (**查询参数**): boolean
180+
181+
<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks</a>
182+
183+
- **continue** (**查询参数**): string
184+
185+
<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue</a>
186+
187+
- **fieldSelector** (**查询参数**): string
188+
189+
<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector</a>
190+
191+
- **labelSelector** (**查询参数**): string
192+
193+
<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector</a>
194+
195+
- **limit** (**查询参数**): integer
196+
197+
<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit</a>
198+
199+
- **pretty** (**查询参数**): string
200+
201+
<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty</a>
202+
203+
- **resourceVersion** (**查询参数**): string
204+
205+
<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion</a>
206+
207+
- **resourceVersionMatch** (**查询参数**): string
208+
209+
<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch</a>
210+
211+
- **timeoutSeconds** (**查询参数**): integer
212+
213+
<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds</a>
214+
215+
- **watch** (**查询参数**): boolean
216+
217+
<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch</a>
218+
219+
<!--
220+
#### Response
221+
-->
222+
#### 响应
223+
200 (<a href="{{< ref "../cluster-resources/component-status-v1#ComponentStatusList" >}}">ComponentStatusList</a>): OK
224+
225+
401: Unauthorized

0 commit comments

Comments
 (0)