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

项目 [config.openshift.io/v1]

描述

Project 保持关于 Project 的集群范围信息。规范名称为 `cluster` 兼容性级别 1：在主要版本中至少稳定 12 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规范

属性 类型 描述

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

对象

spec 包含用户可设置的配置值

status

对象

status 包含来自集群的观察值。它们可能不会被覆盖。

.spec

描述

spec 包含用户可设置的配置值

类型

对象

属性 类型 描述

projectRequestMessage

字符串

projectRequestMessage 是如果用户无法通过 projectrequest api 端点请求项目而向用户呈现的字符串

projectRequestTemplate

对象

projectRequestTemplate 是用于响应 projectrequest 创建项目的模板。此模板必须指向 'openshift-config' 命名空间中的一个模板。它是可选的。如果未指定，则使用默认模板。

.spec.projectRequestTemplate

描述

projectRequestTemplate 是用于响应 projectrequest 创建项目的模板。此模板必须指向 'openshift-config' 命名空间中的一个模板。它是可选的。如果未指定，则使用默认模板。

类型

对象

属性 类型 描述

名称

字符串

名称是所引用项目请求模板的 metadata.name

.status

描述

status 包含来自集群的观察值。它们可能不会被覆盖。

类型

对象

API 端点

提供以下 API 端点：

  • /apis/config.openshift.io/v1/projects

    • DELETE：删除 Project 集合

    • GET：列出 Project 对象

    • POST：创建一个 Project

  • /apis/config.openshift.io/v1/projects/{name}

    • DELETE：删除一个 Project

    • GET：读取指定的 Project

    • PATCH：部分更新指定的 Project

    • PUT：替换指定的 Project

  • /apis/config.openshift.io/v1/projects/{name}/status

    • GET：读取指定 Project 的状态

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

    • PUT：替换指定 Project 的状态

/apis/config.openshift.io/v1/projects

HTTP 方法

DELETE

描述

删除 Project 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 Project 对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

ProjectList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 Project

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Project 模式
表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

Project 模式

201 - 已创建

Project 模式

202 - 已接受

Project 模式

401 - 未授权

空

/apis/config.openshift.io/v1/projects/{name}

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

名称

字符串

Project 的名称
HTTP 方法

DELETE

描述

删除一个 Project

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 Project

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

Project 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 Project

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Project 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 Project

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Project 模式
表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

Project 模式

201 - 已创建

Project 模式

401 - 未授权

空

/apis/config.openshift.io/v1/projects/{name}/status

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

名称

字符串

Project 的名称
HTTP 方法

GET

描述

读取指定 Project 的状态

表 16. HTTP 响应
HTTP 代码 响应体

200 - OK

Project 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定 Project 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

Project 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定 Project 的状态

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

dryRun

字符串

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

fieldValidation

字符串

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

请求体

Project 模式
表 21. HTTP 响应
HTTP 代码 响应体

200 - OK

Project 模式

201 - 已创建

Project 模式

401 - 未授权

空