website/role-v1.md at dd7f235604acad8eadac34d1942c2078ed0c19bb

24 KiB

Raw Blame History

api_metadata

content_type

description

title

weight

auto_generated

apiVersion	import	kind
rbac.authorization.k8s.io/v1	k8s.io/api/rbac/v1	Role

api_reference

Role 是一个按命名空间划分的 PolicyRule 逻辑分组，可以被 RoleBinding 作为一个单元引用。

Role

false

apiVersion: rbac.authorization.k8s.io/v1

import "k8s.io/api/rbac/v1"

Role

Role 是一个按命名空间划分的 PolicyRule 逻辑分组，可以被 RoleBinding 作为一个单元引用。

apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata (<a href="{{< ref "../common-definitions/object-meta#ObjectMeta" >}}">ObjectMeta)

标准的对象元数据。

rules ([]PolicyRule)

rules 包含了这个 Role 的所有 PolicyRule。

PolicyRule 包含描述一个策略规则的信息，但不包含该规则适用于哪个主体或适用于哪个命名空间的信息。
- rules.apiGroups ([]string)
  
  apiGroups 是包含资源的 apiGroup 的名称。如果指定了多个 API 组，则允许对任何 API 组中的其中一个枚举资源来请求任何操作。
- rules.resources ([]string)
  
  resources 是此规则所适用的资源的列表。 “*” 表示所有资源。

rules.verbs ([]string)，必需

verbs 是适用于此规则中所包含的所有 ResourceKinds 的动作。 “*” 表示所有动作。
rules.resourceNames ([]string)

resourceNames 是此规则所适用的资源名称白名单，可选。空集合意味着允许所有资源。
rules.nonResourceURLs ([]string)

nonResourceURLs 是用户应有权访问的一组部分 URL。允许使用 “*”，但仅能作为路径中最后一段且必须用于完整的一段，因为非资源 URL 没有划分命名空间。此字段仅适用于从 ClusterRoleBinding 引用的 ClusterRole。 rules 可以应用到 API 资源（如 “pod” 或 “secret”）或非资源 URL 路径（如 “/api”），但不能同时应用于两者。

RoleList

RoleList 是 Role 的集合。

apiVersion: rbac.authorization.k8s.io/v1
kind: RoleList
metadata (<a href="{{< ref "../common-definitions/list-meta#ListMeta" >}}">ListMeta)

标准的对象元数据。

items ([]<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role)，必需

items 是 Role 的列表。

操作

`get` 读取指定的 Role

HTTP 请求

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

参数

name (路径参数): string，必需

Role 的名称
namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): OK

401: Unauthorized

`list` 列出或观测类别为 Role 的对象

HTTP 请求

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

参数

namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
allowWatchBookmarks (查询参数): boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
continue (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
fieldSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
labelSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
resourceVersion (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
watch (查询参数): boolean

<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#RoleList" >}}">RoleList): OK

401: Unauthorized

`list` 列出或观测类别为 Role 的对象

HTTP 请求

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

参数

allowWatchBookmarks (查询参数): boolean

<a href="{{< ref "../common-parameters/common-parameters#allowWatchBookmarks" >}}">allowWatchBookmarks
continue (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
fieldSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
labelSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
resourceVersion (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds
watch (查询参数): boolean

<a href="{{< ref "../common-parameters/common-parameters#watch" >}}">watch

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#RoleList" >}}">RoleList): OK

401: Unauthorized

`create` 创建 Role

HTTP 请求

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

参数

namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role，必需
dryRun (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): OK

201 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): Created

202 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): Accepted

401: Unauthorized

`update` 替换指定的 Role

HTTP 请求

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

参数

name (路径参数): string，必需

Role 的名称
namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role，必需
dryRun (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): OK

201 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): Created

401: Unauthorized

`patch` 部分更新指定的 Role

HTTP 请求

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

参数

name (路径参数): string，必需

Role 的名称
namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/patch#Patch" >}}">Patch，必需
dryRun (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldManager (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldManager" >}}">fieldManager
fieldValidation (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldValidation" >}}">fieldValidation
force (查询参数): boolean

<a href="{{< ref "../common-parameters/common-parameters#force" >}}">force
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty

响应

200 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): OK

201 (<a href="{{< ref "../authorization-resources/role-v1#Role" >}}">Role): Created

401: Unauthorized

`delete` 删除 Role

HTTP 请求

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

参数

name (路径参数): string，必需

Role 的名称
namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
dryRun (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
gracePeriodSeconds (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

202 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): Accepted

401: Unauthorized

`deletecollection` 删除 Role 的集合

HTTP 请求

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

参数

namespace (路径参数): string，必需

<a href="{{< ref "../common-parameters/common-parameters#namespace" >}}">namespace
body: <a href="{{< ref "../common-definitions/delete-options#DeleteOptions" >}}">DeleteOptions
continue (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#continue" >}}">continue
dryRun (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#dryRun" >}}">dryRun
fieldSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#fieldSelector" >}}">fieldSelector
gracePeriodSeconds (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#gracePeriodSeconds" >}}">gracePeriodSeconds
labelSelector (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#labelSelector" >}}">labelSelector
limit (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#limit" >}}">limit
pretty (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#pretty" >}}">pretty
propagationPolicy (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#propagationPolicy" >}}">propagationPolicy
resourceVersion (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersion" >}}">resourceVersion
resourceVersionMatch (查询参数): string

<a href="{{< ref "../common-parameters/common-parameters#resourceVersionMatch" >}}">resourceVersionMatch
timeoutSeconds (查询参数): integer

<a href="{{< ref "../common-parameters/common-parameters#timeoutSeconds" >}}">timeoutSeconds

响应

200 (<a href="{{< ref "../common-definitions/status#Status" >}}">Status): OK

401: Unauthorized

24 KiB Raw Blame History Unescape Escape

Role

RoleList

操作

get 读取指定的 Role

HTTP 请求

参数

响应

list 列出或观测类别为 Role 的对象

HTTP 请求

参数

响应

list 列出或观测类别为 Role 的对象

HTTP 请求

参数

响应

create 创建 Role

HTTP 请求

参数

响应

update 替换指定的 Role

HTTP 请求

参数

响应

patch 部分更新指定的 Role

HTTP 请求

参数

响应

delete 删除 Role

HTTP 请求

参数

响应

deletecollection 删除 Role 的集合

HTTP 请求

参数

响应

24 KiB

Raw Blame History

`get` 读取指定的 Role

`list` 列出或观测类别为 Role 的对象

`list` 列出或观测类别为 Role 的对象

`create` 创建 Role

`update` 替换指定的 Role

`patch` 部分更新指定的 Role

`delete` 删除 Role

`deletecollection` 删除 Role 的集合