项目 [project.openshift.io/v1] - 项目 API | API 参考 | OpenShift Container Platform 4.17

规范
- .spec
- .status
API端点

描述: 项目是OpenShift中隔离和协作的单元。一个项目拥有一个或多个成员、项目可能消耗的资源配额以及项目中资源的安全控制。在项目中，成员可能具有不同的角色——项目管理员可以设置成员资格，编辑者可以创建和管理资源，查看者可以查看但不能访问正在运行的容器。在普通集群中，项目管理员无法更改其配额——这仅限于集群管理员。

列出或监视项目只会返回用户具有读取器角色的项目。

OpenShift项目是Kubernetes命名空间的另一种表示形式。项目对最终用户公开为可编辑的，而命名空间则不是。直接创建项目通常仅限于管理员，而最终用户应该使用requestproject资源。

兼容性级别1：在主要版本中稳定至少12个月或3个次要版本（以较长者为准）。
类型: 对象

规范

属性类型描述

属性	类型	描述
`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
`元数据`	`ObjectMeta_v2`	metadata 是标准对象的元数据。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
`规范`	`对象`	ProjectSpec 描述了项目上的属性
`状态`	`对象`	ProjectStatus 是关于项目当前状态的信息

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

元数据

ObjectMeta_v2

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

规范

对象

ProjectSpec 描述了项目上的属性

状态

对象

ProjectStatus 是关于项目当前状态的信息

.spec

描述: ProjectSpec 描述了项目上的属性
类型: 对象

属性类型描述

属性	类型	描述
`结束器`	`数组 (字符串)`	Finalizers 是一个不透明的值列表，必须为空才能永久地从存储中删除对象

结束器

数组 (字符串)

Finalizers 是一个不透明的值列表，必须为空才能永久地从存储中删除对象

.status

描述: ProjectStatus 是关于项目当前状态的信息
类型: 对象

属性类型描述

属性	类型	描述
`条件`	`数组 (NamespaceCondition)`	表示项目当前状态的最新可用观察结果。
`阶段`	`字符串`	Phase 是项目的当前生命周期阶段可能的枚举值：- `"Active"` 表示命名空间可用于系统 - `"Terminating"` 表示命名空间正在进行优雅终止

条件

数组 (NamespaceCondition)

表示项目当前状态的最新可用观察结果。

阶段

字符串

Phase 是项目的当前生命周期阶段

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

API 端点

以下 API 端点可用

/apis/project.openshift.io/v1/projects
- GET：列出或监视 Kind 为 Project 的对象
- POST：创建一个 Project
/apis/project.openshift.io/v1/watch/projects
- GET：监视 Project 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。
/apis/project.openshift.io/v1/projects/{name}
- DELETE：删除一个 Project
- GET：读取指定的 Project
- PATCH：部分更新指定的 Project
- PUT：替换指定的 Project
/apis/project.openshift.io/v1/watch/projects/{name}
- GET：监视 Kind 为 Project 的对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

/apis/project.openshift.io/v1/projects

HTTP 方法: GET
描述: 列出或监视 Kind 为 Project 的对象

表 1. HTTP 响应
HTTP 代码	响应体
200 - OK	`ProjectList` 模式
401 - 未授权	空

HTTP 方法: POST
描述: 创建一个 Project

表 2. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
`fieldValidation`	`字符串`	fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为：- Ignore：这将忽略任何被对象静默删除的未知字段，并将忽略解码器遇到的所有重复字段（只保留最后一个）。这是 v1.23 之前的默认行为。- Warn：这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误，请求仍将成功，并且只保留任何重复字段中的最后一个。这是 v1.23 及更高版本的默认值 - Strict：如果任何未知字段将从对象中删除，或者如果存在任何重复字段，这将导致请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。

表 3. 请求体参数
参数	类型	描述
`body`	`Project` 模式

表 4. HTTP 响应
HTTP 代码	响应体
200 - OK	`Project` 模式
201 - 已创建	`Project` 模式
202 - 已接受	`Project` 模式
401 - 未授权	空

/apis/project.openshift.io/v1/watch/projects

HTTP 方法: GET
描述: 监视 Project 列表的单个更改。已弃用：请改用列表操作中的“watch”参数。

表 5. HTTP 响应
HTTP 代码	响应体
200 - OK	`WatchEvent` 模式
401 - 未授权	空

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

表 6. 全局路径参数
参数	类型	描述
`name`	`字符串`	Project 的名称

HTTP 方法: DELETE
描述: 删除一个 Project

表 7. 查询参数
参数	类型	描述
`dryRun`	`字符串`	如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

表 8. HTTP 响应
HTTP 代码	响应体
200 - OK	`Status_v7` 模式
202 - 已接受	`Status_v7` 模式
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` 模式
201 - 已创建	`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. 请求体参数
参数	类型	描述
`body`	`Project` 模式

表 14. HTTP 响应
HTTP 代码	响应体
200 - OK	`Project` 模式
201 - 已创建	`Project` 模式
401 - 未授权	空

/apis/project.openshift.io/v1/watch/projects/{name}

表 15. 全局路径参数
参数	类型	描述
`name`	`字符串`	Project 的名称

HTTP 方法: GET
描述: 监视 Kind 为 Project 的对象的更改。已弃用：请改用列表操作中的“watch”参数，并使用“fieldSelector”参数将其过滤为单个项目。

表 16. HTTP 响应
HTTP 代码	响应体
200 - OK	`WatchEvent` 模式
401 - 未授权	空