为 IAM 用户或角色授予 RBAC 访问权限。

接口说明

在 VKE 集群中，非集群创建者在集群中默认没有任何 RBAC（Role-Based Access Control ，基于角色的权限控制）权限。您可以调用 GrantPermission 接口，为 IAM 用户或角色授予 RBAC 访问权限，包括可访问的资源、权限的作用范围、预置的角色类型等，从而更好地管理集群的安全访问控制。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=GrantPermission&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	GrantPermission	接口名称。当前 API 的名称为 GrantPermission。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
RoleDomain	String	否	cluster	为 IAM 用户或角色授予的权限类型，取值如下： namespace：授予命名空间级别的权限。 cluster：授予集群级别的权限。 all_clusters：授予当前账号下全部集群级别的权限。
ClusterId	String	否	ccog93v*******	需要授权给 IAM 用户或角色的集群 ID。可以调用 ListClusters 接口，获取集群 ID。注意 roleDomain为namespace或cluster时必须填写该参数值。
Namespace	String	否	default	需要授权给 IAM 用户或角色的名空间名称。可以登录容器服务控制台，查看命名空间名称。注意 roleDomain等于namespace时必须填写该参数值。 roleDomain不等于namespace时，填写该参数值不生效。
RoleName	String	否	vke:admin	给被授权者授予的 RBAC 角色名称。可以授予如下 RBAC 权限：自定义角色名称：您可以自定义一个角色名称，名称格式、字符串等 VKE 侧无限制，只要符合 Kubernetes 规范即可。系统预置的角色名称：可授予的系统预置 RBAC 角色名称，请参见 RBAC 权限角色说明。注意目前必须填写该参数。当roleDomain为all_clusters时，不可以自定义角色名称。
IsCustomRole	Boolean	否	false	给被授权者授予的 RBAC 角色是否为自定义角色，取值如下： true：自定义角色。 false：（默认值）系统预置的角色。
GranteeId	Long	否	153******	被授权者的 ID。可以是 IAM 用户 ID，也可以是 IAM 角色 ID。可以调用 ListUsers 或 ListRoles 接口，获取 ID。注意目前该参数必须填写。
GranteeType	String	否	User	被授权者的类型，取值如下： User：IAM 用户。 Role：IAM 角色。 All：所有类型。

请求示例

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

参数	类型	示例值	描述
Id	String	ap********	RBAC 权限策略资源的 ID。您可以自行记录保存该 ID，以便后续使用 ID 进行查询或变更 RBAC 访问策略相关操作。

返回示例

错误码

本接口无专有错误码，公共错误码请参见公共错误码。

容器服务