diff --git a/content/zh/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md b/content/zh/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md new file mode 100644 index 0000000000000..dc0e8d4ef2e02 --- /dev/null +++ b/content/zh/docs/reference/kubernetes-api/cluster-resources/namespace-v1.md @@ -0,0 +1,839 @@ +--- +api_metadata: + apiVersion: "v1" + import: "k8s.io/api/core/v1" + kind: "Namespace" +content_type: "api_reference" +description: "Namespace 为名字提供作用域。" +title: "Namespace" +weight: 2 +--- + + + +`apiVersion: v1` + +`import "k8s.io/api/core/v1"` + +## Namespace {#Namespace} + +Namespace 为名字提供作用域。使用多个命名空间是可选的。 +
+ +- **apiVersion**: v1 + +- **kind**: Namespace + +- **metadata** (}}">ObjectMeta) + + 标准的对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata + +- **spec** (}}">NamespaceSpec) + + spec 定义了 Namespace 的行为。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +- **status** (}}">NamespaceStatus) + + status 描述了当前 Namespace 的状态。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + +## NamespaceSpec {#NamespaceSpec} + +NamespaceSpec 用于描述 Namespace 的属性。 + +
+ +- **finalizers** ([]string) + + + finalizers 是一个不透明的值列表,只有此列表为空时才能从存储中永久删除对象。 更多信息: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + +## NamespaceStatus {#NamespaceStatus} + +NamespaceStatus 表示 Namespace 的当前状态信息。 +
+ +- **conditions** ([]NamespaceCondition) + + **补丁策略:基于 `type` 健合并** + + 表示命名空间当前状态的最新可用状况。 + + + + **NamespaceCondition 包含命名空间状态的详细信息。** + + - **conditions.status** (string),必需 + + 状况(condition)的状态,取值为 True、False 或 Unknown 之一。 + + - **conditions.type** (string), 必需 + + 命名空间控制器状况的类型。 + + - **conditions.lastTransitionTime** (Time) + + + + **Time 是对 time.Time 的封装。Time 支持对 YAML 和 JSON 进行正确封包。为 time 包的许多函数方法提供了封装器。** + + - **conditions.message** (string) + + - **conditions.reason** (string) + +- **phase** (string) + + + phase 是命名空间的当前生命周期阶段。更多信息: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ + +## NamespaceList {#NamespaceList} + +NamespaceList 是一个命名空间列表。 +
+ +- **apiVersion**: v1 + + +- **kind**: NamespaceList + + +- **metadata** (}}">ListMeta) + + 标准的列表元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + + + +- **items** ([]}}">Namespace),必需 + + + items 是列表中的 Namespace 对象列表。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ + + + +## 操作 {#Operations} + + +
+ +### `get` 读取指定的 Namespace + +#### HTTP 请求 + +GET /api/v1/namespaces/{name} + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +401:Unauthorized + + +### `get` 读取指定 Namespace 的状态 + +#### HTTP 请求 + +GET /api/v1/namespaces/{name}/status + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +401:Unauthorized + + +### `list` 列出或者检查类别为 Namespace 的对象 + +#### HTTP 请求 + +GET /api/v1/namespaces + +#### 参数 + + +- **allowWatchBookmarks** (**查询参数**):boolean + + }}">allowWatchBookmarks + + +- **continue** (**查询参数**):string + + }}">continue + + +- **fieldSelector** (**查询参数**):string + + }}">fieldSelector + + +- **labelSelector** (**查询参数**):string + + }}">labelSelector + + +- **limit** (**查询参数**):integer + + }}">limit + + +- **pretty** (**查询参数**):string + + }}">pretty + + +- **resourceVersion** (**查询参数**):string + + }}">resourceVersion + + +- **resourceVersionMatch** (**查询参数**):string + + }}">resourceVersionMatch + + +- **timeoutSeconds** (**查询参数**):integer + + }}">timeoutSeconds + + +- **watch** (**查询参数**):boolean + + }}">watch + + +#### 响应 + +200 (}}">NamespaceList):OK + +401:Unauthorized + + +### `create` 创建一个 Namespace + +#### HTTP 请求 + +POST /api/v1/namespaces + +#### 参数 + +- **body**: }}">Namespace,必需 + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +202 (}}">Namespace):Accepted + +401:Unauthorized + + +### `update` 替换指定的 Namespace + +#### HTTP 请求 + +PUT /api/v1/namespaces/{name} + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + +- **body**: }}">Namespace, 必需 + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +401:Unauthorized + + +### `update` 替换指定 Namespace 的终结器 + +#### HTTP 请求 + +PUT /api/v1/namespaces/{name}/finalize + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + +- **body**: }}">Namespace,必需 + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +401:Unauthorized + + +### `update` 替换指定 Namespace 的状态 + +#### HTTP 请求 + +PUT /api/v1/namespaces/{name}/status + +#### 参数 + + +- **name** (**路径阐述**):string,必需 + + Namespace 的名称 + +- **body**: }}">Namespace,必需 + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +401: Unauthorized + + +### `patch` 部分更新指定的 Namespace + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{name} + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + + +- **body**: }}">Patch,必需 + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **force** (**查询参数**):boolean + + }}">force + + +- **pretty** (**查询参数**): string + + }}">pretty + + +#### 响应 + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +401: Unauthorized + + +### `patch` 部分更新指定 Namespace 的状态 + +#### HTTP 请求 + +PATCH /api/v1/namespaces/{name}/status + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + + +- **body**: }}">Patch,必需 + + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **fieldManager** (**查询参数**):string + + }}">fieldManager + + +- **fieldValidation** (**查询参数**):string + + }}">fieldValidation + + +- **force** (**查询参数**): boolean + + }}">force + + +- **pretty** (**查询参数**):string + + }}">pretty + + +#### 响应 + + +200 (}}">Namespace):OK + +201 (}}">Namespace):Created + +401:Unauthorized + + +### `delete` 删除一个 Namespace + +#### HTTP 请求 + +DELETE /api/v1/namespaces/{name} + +#### 参数 + + +- **name** (**路径参数**):string,必需 + + Namespace 的名称 + +- **body**: }}">DeleteOptions + + +- **dryRun** (**查询参数**):string + + }}">dryRun + + +- **gracePeriodSeconds** (*查询参数*):integer + + }}">gracePeriodSeconds + + +- **pretty** (**查询参数**):string + + }}">pretty + + +- **propagationPolicy** (**查询参数**):string + + }}">propagationPolicy + + +#### 响应 + +200 (}}">Status):OK + +202 (}}">Status):Accepted + +401:Unauthorized