×

规格

属性 类型 描述

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

标准对象的元数据。

rules

数组

Rules 包含此 Role 的所有 PolicyRules

rules[]

对象

PolicyRule 包含描述策略规则的信息,但不包含有关规则适用于谁或规则适用于哪个命名空间的信息。

.rules

描述

Rules 包含此 Role 的所有 PolicyRules

类型

数组

.rules[]

描述

PolicyRule 包含描述策略规则的信息,但不包含有关规则适用于谁或规则适用于哪个命名空间的信息。

类型

对象

必需
  • verbs

属性 类型 描述

apiGroups

数组 (字符串)

APIGroups 是包含资源的 APIGroup 的名称。如果指定多个 API 组,则允许针对任何 API 组中列出的任何资源请求的任何操作。“”代表核心 API 组,“*”代表所有 API 组。

nonResourceURLs

数组 (字符串)

NonResourceURLs 是一组用户应该可以访问的部分 URL。允许使用 *,但仅限于路径的完整最终步骤。由于非资源 URL 没有命名空间,因此此字段仅适用于从 ClusterRoleBinding 引用 ClusterRole 的情况。规则可以应用于 API 资源(例如“pods”或“secrets”)或非资源 URL 路径(例如“/api”),但不能同时应用于两者。

resourceNames

数组 (字符串)

ResourceNames 是规则适用的名称的可选白名单。空集表示允许所有内容。

resources

数组 (字符串)

Resources 是此规则适用的资源列表。“*”表示所有资源。

verbs

数组 (字符串)

Verbs 是应用于此规则中包含的所有 ResourceKinds 的 Verbs 列表。“*”表示所有动词。

API 端点

提供以下 API 端点

  • /apis/rbac.authorization.k8s.io/v1/roles

    • GET:列出或监视 Role 类型的对象

  • /apis/rbac.authorization.k8s.io/v1/watch/roles

    • GET:监视 Role 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

  • /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles

    • DELETE:删除 Role 集合

    • GET:列出或监视 Role 类型的对象

    • POST:创建 Role

  • /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles

    • GET:监视 Role 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

  • /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

    • DELETE:删除 Role

    • GET:读取指定的 Role

    • PATCH:部分更新指定的 Role

    • PUT:替换指定的 Role

  • /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}

    • GET:监视 Role 类型对象的更改。已弃用:改用列表操作中的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。

/apis/rbac.authorization.k8s.io/v1/roles

HTTP 方法

GET

描述

列出或监视 Role 类型的对象

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

200 - OK

RoleList 模式

401 - 未授权

/apis/rbac.authorization.k8s.io/v1/watch/roles

HTTP 方法

GET

描述

监视 Role 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

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

200 - OK

WatchEvent 模式

401 - 未授权

/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles

HTTP 方法

DELETE

描述

删除 Role 集合

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

dryRun

字符串

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

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

200 - OK

Status 模式

401 - 未授权

HTTP 方法

GET

描述

列出或监视 Role 类型的对象

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

200 - OK

RoleList 模式

401 - 未授权

HTTP 方法

POST

描述

创建 Role

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

dryRun

字符串

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

fieldValidation

字符串

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

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

body

Role 模式

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

200 - OK

Role 模式

201 - 已创建

Role 模式

202 - 已接受

Role 模式

401 - 未授权

/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles

HTTP 方法

GET

描述

监视 Role 列表的单个更改。已弃用:改用列表操作中的“watch”参数。

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

200 - OK

WatchEvent 模式

401 - 未授权

/apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}

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

name

字符串

Role 的名称

HTTP 方法

DELETE

描述

删除 Role

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

dryRun

字符串

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

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

HTTP 方法

GET

描述

读取指定的 Role

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

200 - OK

Role 模式

401 - 未授权

HTTP 方法

PATCH

描述

部分更新指定的 Role

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

dryRun

字符串

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

fieldValidation

字符串

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

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

200 - OK

Role 模式

201 - 已创建

Role 模式

401 - 未授权

HTTP 方法

PUT

描述

替换指定的 Role

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

dryRun

字符串

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

fieldValidation

字符串

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

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

body

Role 模式

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

200 - OK

Role 模式

201 - 已创建

Role 模式

401 - 未授权

/apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}

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

name

字符串

Role 的名称

HTTP 方法

GET

描述

监视 Role 类型对象的更改。已弃用:改用列表操作中的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。

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

200 - OK

WatchEvent 模式

401 - 未授权