OpenShift 文档正在迁移，很快将只在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

命名空间 [v1]

规范

属性 类型 描述

apiVersion

字符串

APIVersion定义了对象的此表示形式的版本化模式。服务器应将识别的模式转换为最新的内部值，并可能拒绝无法识别的值。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

Kind是一个字符串值，表示此对象表示的REST资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。采用驼峰式命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

NamespaceSpec描述了命名空间上的属性。

status

对象

NamespaceStatus是关于命名空间当前状态的信息。

.spec

描述

NamespaceSpec描述了命名空间上的属性。

类型

对象

属性 类型 描述

finalizers

数组 (字符串)

Finalizers是一个不透明的值列表，必须为空才能永久地从存储中删除对象。更多信息：https://kubernetes.ac.cn/docs/tasks/administer-cluster/namespaces/

.status

描述

NamespaceStatus是关于命名空间当前状态的信息。

类型

对象

属性 类型 描述

conditions

数组

表示命名空间当前状态的最新可用观察结果。

conditions[]

对象

NamespaceCondition包含有关命名空间状态的详细信息。

phase

字符串

Phase是命名空间的当前生命周期阶段。更多信息：https://kubernetes.ac.cn/docs/tasks/administer-cluster/namespaces/

可能的枚举值：- "Active" 表示命名空间可用于系统 - "Terminating" 表示命名空间正在经历优雅终止

.status.conditions

描述

表示命名空间当前状态的最新可用观察结果。

类型

数组

.status.conditions[]

描述

NamespaceCondition包含有关命名空间状态的详细信息。

类型

对象

必需

  • 类型

  • status

属性 类型 描述

lastTransitionTime

时间

message

字符串

reason

字符串

status

字符串

条件的状态，True、False、Unknown之一。

类型

字符串

命名空间控制器条件的类型。

API端点

提供以下API端点

  • /api/v1/namespaces

    • GET：列出或监视Namespace类型的对象

    • POST：创建Namespace

  • /api/v1/watch/namespaces

    • GET：监视对Namespace列表的单个更改。已弃用：改用带有列表操作的“watch”参数。

  • /api/v1/namespaces/{name}

    • DELETE：删除Namespace

    • GET：读取指定的Namespace

    • PATCH：部分更新指定的Namespace

    • PUT：替换指定的Namespace

  • /api/v1/watch/namespaces/{name}

    • GET：监视对Namespace类型对象的更改。已弃用：改用带有列表操作的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

  • /api/v1/namespaces/{name}/status

    • GET：读取指定Namespace的状态

    • PATCH：部分更新指定Namespace的状态

    • PUT：替换指定Namespace的状态

  • /api/v1/namespaces/{name}/finalize

    • PUT：替换指定Namespace的finalize

/api/v1/namespaces

HTTP方法

GET

描述

列出或监视Namespace类型的对象

表1. HTTP响应
HTTP代码 响应正文

200 - OK

NamespaceList 模式

401 - 未授权

空
HTTP方法

POST

描述

创建Namespace

表2. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表3. 主体参数
参数 类型 描述

body

Namespace 模式
表4. HTTP响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

202 - 已接受

Namespace 模式

401 - 未授权

空

/api/v1/watch/namespaces

HTTP方法

GET

描述

监控命名空间列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 5. HTTP 响应
HTTP代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/api/v1/namespaces/{name}

表 6. 全局路径参数
参数 类型 描述

name

字符串

命名空间名称
HTTP方法

DELETE

描述

删除命名空间

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段
表 8. HTTP 响应
HTTP代码 响应正文

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP方法

GET

描述

读取指定的命名空间

表 9. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定的命名空间

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 11. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定的命名空间

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 13. 请求体参数
参数 类型 描述

body

Namespace 模式
表 14. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

401 - 未授权

空

/api/v1/watch/namespaces/{name}

表 15. 全局路径参数
参数 类型 描述

name

字符串

命名空间名称
HTTP方法

GET

描述

监控 Namespace 对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数过滤为单个项目。

表 16. HTTP 响应
HTTP代码 响应正文

200 - OK

WatchEvent 模式

401 - 未授权

空

/api/v1/namespaces/{name}/status

表 17. 全局路径参数
参数 类型 描述

name

字符串

命名空间名称
HTTP方法

GET

描述

读取指定命名空间的状态

表 18. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

401 - 未授权

空
HTTP方法

PATCH

描述

部分更新指定命名空间的状态

表 19. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 20. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

401 - 未授权

空
HTTP方法

PUT

描述

替换指定命名空间的状态

表 21. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
表 22. 请求体参数
参数 类型 描述

body

Namespace 模式
表 23. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

401 - 未授权

空

/api/v1/namespaces/{name}/finalize

表 24. 全局路径参数
参数 类型 描述

name

字符串

命名空间名称
表 25. 全局查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的dryRun指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有dry run阶段

fieldValidation

字符串

fieldValidation指示服务器如何处理请求（POST/PUT/PATCH）中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何静默从对象中删除的未知字段，并且将忽略解码器遇到的最后一个重复字段以外的所有字段。这是v1.23之前的默认行为。- Warn：这将通过标准警告响应报头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍然会成功，并且只会保留任何重复字段中的最后一个。这是v1.23+中的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将使请求失败并出现BadRequest错误。服务器返回的错误将包含遇到的所有未知和重复字段。
HTTP方法

PUT

描述

替换指定命名空间的finalize

表 26. 请求体参数
参数 类型 描述

body

Namespace 模式
表 27. HTTP 响应
HTTP代码 响应正文

200 - OK

Namespace 模式

201 - 已创建

Namespace 模式

401 - 未授权

空