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