Skip to content

Commit 7962632

Browse files
authored
Merge pull request #32520 from howieyuen/ref_api_common_status
[zh]translate content/docs/reference/kubernetes-api/common-definition…
2 parents 3681ef4 + 43efe82 commit 7962632

File tree

1 file changed

+208
-0
lines changed
  • content/zh/docs/reference/kubernetes-api/common-definitions

1 file changed

+208
-0
lines changed
Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
---
2+
api_metadata:
3+
apiVersion: ""
4+
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
5+
kind: "Status"
6+
content_type: "api_reference"
7+
description: "状态(Status)是不返回其他对象的调用的返回值。"
8+
title: "Status"
9+
weight: 12
10+
auto_generated: true
11+
---
12+
13+
<!--
14+
api_metadata:
15+
apiVersion: ""
16+
import: "k8s.io/apimachinery/pkg/apis/meta/v1"
17+
kind: "Status"
18+
content_type: "api_reference"
19+
description: "Status is a return value for calls that don't return other objects."
20+
title: "Status"
21+
weight: 12
22+
auto_generated: true
23+
-->
24+
25+
<!--
26+
The file is auto-generated from the Go source code of the component using a generic
27+
[generator](https://github.com/kubernetes-sigs/reference-docs/). To learn how
28+
to generate the reference documentation, please read
29+
[Contributing to the reference documentation](/docs/contribute/generate-ref-docs/).
30+
To update the reference content, please follow the
31+
[Contributing upstream](/docs/contribute/generate-ref-docs/contribute-upstream/)
32+
guide. You can file document formatting bugs against the
33+
[reference-docs](https://github.com/kubernetes-sigs/reference-docs/) project.
34+
-->
35+
36+
37+
38+
`import "k8s.io/apimachinery/pkg/apis/meta/v1"`
39+
40+
41+
<!-- Status is a return value for calls that don't return other objects. -->
42+
状态(Status)是不返回其他对象的调用的返回值。
43+
44+
<hr>
45+
46+
- **apiVersion** (string)
47+
48+
<!--
49+
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
50+
-->
51+
52+
APIVersion 定义对象表示的版本化模式。
53+
服务器应将已识别的模式转换为最新的内部值,并可能拒绝无法识别的值。
54+
更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
55+
56+
- **code** (int32)
57+
58+
<!-- Suggested HTTP return code for this status, 0 if not set. -->
59+
此状态的建议 HTTP 返回代码,如果未设置,则为 0。
60+
61+
- **details** (StatusDetails)
62+
63+
<!--
64+
Extended data associated with the reason. Each reason may define its own extended details.
65+
This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
66+
-->
67+
与原因(Reason)相关的扩展数据。每个原因都可以定义自己的扩展细节。
68+
此字段是可选的,并且不保证返回的数据符合任何模式,除非由原因类型定义。
69+
70+
<a name="StatusDetails"></a>
71+
<!--
72+
*StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response.
73+
The Reason field of a Status object defines what attributes will be set.
74+
Clients must ignore fields that do not match the defined type of each attribute,
75+
and should assume that any attribute may be empty, invalid, or under defined.*
76+
-->
77+
*StatusDetails 是一组附加属性,可以由服务器设置以提供有关响应的附加信息。*
78+
*状态对象的原因字段定义将设置哪些属性。*
79+
*客户端必须忽略与每个属性的定义类型不匹配的字段,并且应该假定任何属性可能为空、无效或未定义。*
80+
81+
- **details.causes** ([]StatusCause)
82+
83+
<!--
84+
The Causes array includes more details associated with the StatusReason failure.
85+
Not all StatusReasons may provide detailed causes.
86+
-->
87+
Causes 数组包含与 StatusReason 故障相关的更多详细信息。
88+
并非所有 StatusReasons 都可以提供详细的原因。
89+
90+
<a name="StatusCause"></a>
91+
<!--
92+
*StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.*
93+
-->
94+
*StatusCause 提供有关 api.Status 失败的更多信息,包括遇到多个错误的情况。*
95+
96+
- **details.causes.field** (string)
97+
98+
<!--
99+
The field of the resource that has caused this error, as named by its JSON serialization.
100+
May include dot and postfix notation for nested attributes. Arrays are zero-indexed.
101+
Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
102+
-->
103+
导致此错误的资源字段,由其 JSON 序列化命名。
104+
可能包括嵌套属性的点和后缀表示法。数组是从零开始索引的。
105+
由于字段有多个错误,字段可能会在一系列原因中出现多次。可选。
106+
107+
<!--
108+
Examples:
109+
"name" - the field "name" on the current resource
110+
"items[0].name" - the field "name" on the first array entry in "items"
111+
-->
112+
示例:
113+
- “name”:当前资源上的字段 “name”
114+
- “items[0].name”:“items” 中第一个数组条目上的字段 “name”
115+
116+
- **details.causes.message** (string)
117+
118+
<!-- A human-readable description of the cause of the error. This field may be presented as-is to a reader. -->
119+
对错误原因的可读描述。该字段可以按原样呈现给读者。
120+
121+
- **details.causes.reason** (string)
122+
123+
<!-- A machine-readable description of the cause of the error. If this value is empty there is no information available. -->
124+
错误原因的机器可读描述。如果此值为空,则没有可用信息。
125+
126+
- **details.group** (string)
127+
128+
<!-- The group attribute of the resource associated with the status StatusReason. -->
129+
与状态 StatusReason 关联的资源的组属性。
130+
131+
- **details.kind** (string)
132+
133+
<!--
134+
The kind attribute of the resource associated with the status StatusReason.
135+
On some operations may differ from the requested resource Kind.
136+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
137+
-->
138+
与状态 StatusReason 关联的资源的种类属性。
139+
在某些操作上可能与请求的资源种类不同。
140+
更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
141+
142+
- **details.name** (string)
143+
144+
<!-- The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). -->
145+
与状态 StatusReason 关联的资源的名称属性(当有一个可以描述的名称时)。
146+
147+
- **details.retryAfterSeconds** (int32)
148+
149+
<!--
150+
If specified, the time in seconds before the operation should be retried.
151+
Some errors may indicate the client must take an alternate action -
152+
for those errors this field may indicate how long to wait before taking the alternate action.
153+
-->
154+
如果指定,则应重试操作前的时间(以秒为单位)。
155+
一些错误可能表明客户端必须采取替代操作——对于这些错误,此字段可能指示在采取替代操作之前等待多长时间。
156+
157+
- **details.uid** (string)
158+
159+
<!--
160+
UID of the resource. (when there is a single resource which can be described).
161+
More info: http://kubernetes.io/docs/user-guide/identifiers#uids
162+
-->
163+
资源的 UID(当有单个可以描述的资源时)。
164+
更多信息:http://kubernetes.io/docs/user-guide/identifiers#uids
165+
166+
- **kind** (string)
167+
168+
<!--
169+
Kind is a string value representing the REST resource this object represents.
170+
Servers may infer this from the endpoint the client submits requests to.
171+
Cannot be updated. In CamelCase.
172+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
173+
-->
174+
Kind 是一个字符串值,表示此对象表示的 REST 资源。
175+
服务器可以从客户端提交请求的端点推断出这一点。
176+
无法更新。驼峰式规则。
177+
更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
178+
179+
- **message** (string)
180+
181+
<!-- A human-readable description of the status of this operation. -->
182+
此操作状态的人类可读描述。
183+
184+
- **metadata** (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta</a>)
185+
186+
<!-- Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -->
187+
标准列表元数据。
188+
更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
189+
190+
191+
- **reason** (string)
192+
193+
<!--
194+
A machine-readable description of why this operation is in the "Failure" status.
195+
If this value is empty there is no information available.
196+
A Reason clarifies an HTTP status code but does not override it.
197+
-->
198+
机器可读的说明,说明此操作为何处于“失败”状态。
199+
如果此值为空,则没有可用信息。
200+
Reason 澄清了 HTTP 状态代码,但不会覆盖它。
201+
202+
- **status** (string)
203+
204+
<!--
205+
Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
206+
-->
207+
操作状态。“Success”或“Failure” 之一。
208+
更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

0 commit comments

Comments
 (0)