Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

24.3. ClusterRole [authorization.openshift.io/v1]

描述
ClusterRole 是 PolicyRules 的逻辑分组，可作为 ClusterRoleBindings 的单元引用。
类型
对象
必填
  • rules

24.3.1. 规格
复制链接

Expand
属性类型描述

aggregationRule

AggregationRule

AggregationRule 是一个可选字段，用于描述如何为这个 ClusterRole 构建规则。如果设置了 AggregationRule，则规则由控制器管理，并直接更改规则将由控制器停止。

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

 

rules

array

规则包含此 ClusterRole 的所有 PolicyRules

rules[]

对象

PolicyRule 包含描述策略规则的信息，但不包含有关规则应用到的命名空间的信息。

24.3.1.1. .rules
复制链接

描述
规则包含此 ClusterRole 的所有 PolicyRules
类型
array

24.3.1.2. .rules[]
复制链接

描述
PolicyRule 包含描述策略规则的信息，但不包含有关规则应用到的命名空间的信息。
类型
对象
必填
  • verbs
  • resources
Expand
属性类型描述

apiGroups

数组（字符串）

apiGroups 是包含资源的 APIGroup 的名称。如果此字段为空，则假定 kubernetes 和 origin API 组。这意味着，如果针对 kubernetes 或原始 API 组中的其中一个枚举的资源请求一个操作，则允许请求

attributeRestrictions

RawExtension

AttributeRestrictions 将根据 Authorizer/AuthorizationAttributeBuilder 对支持的而有所不同。如果 Authorizer 无法识别如何处理 AttributeRestrictions，Authorizer 应该会报告错误。

nonResourceURLs

数组（字符串）

NonResourceURLsSlice 是用户应该有权访问的一组部分 url。允许，但仅作为路径中的完整步骤与内部类型不同，以便 DefaultConvert 正常工作，并且因为排序可能不同。

resourceNames

数组（字符串）

resourceNames 是规则应用到的可选名称列表。空集表示允许所有内容。

resources

数组（字符串）

resources 是此规则应用到的资源列表。ResourceAll 代表所有资源。

verbs

数组（字符串）

verbs 是一个 Verbs 列表，适用于此规则中包含的所有 ResourceKinds 和 AttributeRestrictions。VerbAll 代表所有类型。

24.3.2. API 端点
复制链接

可用的 API 端点如下：

  • /apis/authorization.openshift.io/v1/clusterroles

    • GET: 列出 ClusterRole 类型的对象
    • POST ：创建一个 ClusterRole

  • /apis/authorization.openshift.io/v1/clusterroles/{name}

    • DELETE ：删除 ClusterRole
    • GET ：读取指定的 ClusterRole
    • PATCH ：部分更新指定的 ClusterRole
    • PUT ：替换指定的 ClusterRole

24.3.2.1. /apis/authorization.openshift.io/v1/clusterroles
复制链接

Expand
表 24.19. 全局查询参数
参数类型描述

pretty

字符串

如果 'true'，则输出被用户友善。

HTTP 方法
GET
描述
列出 ClusterRole 类型的对象
Expand
表 24.20. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签，由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回，也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视，则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks，则忽略此字段。

继续

字符串

从服务器检索更多结果时，应设置 continue 选项。由于这个值是定义的服务器，因此客户端只能使用之前查询结果中的 continue 值，并带有相同的查询参数（除 continue 值除外），因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效，无论是因为过期时间（通常为 5 到十五分钟）还是服务器上的配置更改，服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表，它必须在没有 continue 字段的情况下重启其列表。否则，客户端可能会发送另一个列表请求，并带有 410 错误收到的令牌，服务器将通过从下一个密钥开始的列表进行响应，但从最新的快照（从最后一个列表结果中不一致） - 在第一个列表请求后创建、修改或删除的对象将包含在响应中，只要其密钥在"next key"后。

当 watch 为 true 时，不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视，而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目，服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值，以检索下一个结果集。在过滤所有请求的对象时，设置限制可能会返回比请求的项目数量少（最多为零项），客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数，并将返回所有可用的结果。如果指定了限制，并且 continue 字段为空，客户端可能会假设没有更多可用的结果。如果 watch 为 true，则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说，在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照，并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象，则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间，无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改，并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 24.21. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterRoleList schema

401 - Unauthorized

空

HTTP 方法
POST
描述
创建 ClusterRole
Expand
表 24.22. 查询参数
参数类型描述

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 24.23. 主体参数
参数类型描述

正文（body）

ClusterRole 模式

 
Expand
表 24.24. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterRole 模式

201 - Created

ClusterRole 模式

202 - Accepted

ClusterRole 模式

401 - Unauthorized

空

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

name

字符串

ClusterRole 的名称

Expand
表 24.26. 全局查询参数
参数类型描述

pretty

字符串

如果 'true'，则输出被用户友善。

HTTP 方法
DELETE
描述
删除 ClusterRole
Expand
表 24.27. 查询参数
参数类型描述

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间（以秒为单位）。值必须是非负整数。值零表示立即删除。如果这个值是 nil，则使用指定类型的默认宽限期。如果没有指定，则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用：请使用 PropagationPolicy，此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false，"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy，但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置，但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为： 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系； 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 24.28. 主体参数
参数类型描述

正文（body）

DeleteOptions 模式

 
Expand
表 24.29. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

空

HTTP 方法
GET
描述
读取指定的 ClusterRole
Expand
表 24.30. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterRole 模式

401 - Unauthorized

空

HTTP 方法
PATCH
描述
部分更新指定的 ClusterRole
Expand
表 24.31. 查询参数
参数类型描述

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段，但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。

force

布尔值

强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求，必须取消设置 force 标志。

Expand
表 24.32. 主体参数
参数类型描述

正文（body）

Patch 模式

 
Expand
表 24.33. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterRole 模式

401 - Unauthorized

空

HTTP 方法
PUT
描述
替换指定的 ClusterRole
Expand
表 24.34. 查询参数
参数类型描述

dryRun

字符串

出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 24.35. 主体参数
参数类型描述

正文（body）

ClusterRole 模式

 
Expand
表 24.36. HTTP 响应
HTTP 代码响应正文

200 - OK

ClusterRole 模式

201 - Created

ClusterRole 模式

401 - Unauthorized

空

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat