You need to enable JavaScript to run this app.
导航
ListPermissions
最近更新时间:2024.12.03 17:54:52首次发布时间:2024.12.03 17:54:52

查询符合条件的 RBAC 访问策略资源信息。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=ListPermissions&Version=2022-05-12

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringListPermissions接口名称。当前 API 的名称为 ListPermissions
VersionString2022-05-12接口版本。当前 API 的版本为 2022-05-12
FilterObject of ListPermissionsFilter-待查询访问策略资源的筛选条件。
PageNumberInteger1分页查询时的起始页码,从 1 开始,默认为 1。

PageSize

Integer

10

分页查询时每页显示的记录数,取值:

  • 最小值:1
  • 最大值:100
  • 默认值:10

ListPermissionsFilter

参数类型是否必选示例值描述

Ids

Array of String

["ap******12"]

RBAC 权限策略资源的 ID 列表。调用 GrantPermission 接口时,会返回 RBAC 权限策略资源的 ID。

说明

  • 单次最多填写 100 个资源 ID。
  • 此参数为空数组时,筛选基于账号下的所有 RBAC 权限策略资源。

Status

String

Success

RBAC 权限访问策略资源的状态,取值如下:

  • Success:授权成功。
  • Failed:授权失败。

说明

传入多个状态时,状态间是逻辑「或」关系。

RoleNames

Array of String

["vke:admin"]

给被授权者授予的 RBAC 角色名称列表,取值说明如下:

  • 自定义的角色名称:您自定义的角色名称。
  • 系统预置的角色名称:系统预置的 RBAC 角色名称,详情请参见 RBAC 权限角色说明

说明

单次最多填写 100 个 RBAC 角色名称。

ClusterIds

Array of String

[ccog93v*******]

RBAC 权限策略资源关联的集群 ID 列表。可以调用 ListClusters 接口,获取集群 ID。

说明

单次最多填写 100 个集群 ID。

GranteeIds

Array of Long

[153******]

被授权者的 ID。默认为 IAM 用户 ID,也可以填写 IAM 角色 ID。

注意

  • 如填写 IAM 角色 ID,必须还要传入 GranteeType 参数值。
  • 单次最多填写 100 个 ID。
  • 可以调用 ListUsers 或 ListRoles 接口,获取 ID。
NamespacesArray of String["default"]RBAC 权限策略资源关联的命名空间列表。可以登录 容器服务控制台,查看命名空间名称。

GranteeType

String

User

被授权者的类型,取值如下:

  • User:IAM 用户。
  • Role:IAM 角色。

请求示例

POST https://open.volcengineapi.com/?Action=ListPermissions&Version=2022-05-12
Content-Type: application/json
{
    "Filter": {
        "Ids": [
            "ap******12"
        ],
        "Status": "Success",
        "RoleNames": [
            "vke: admin"
        ],
        "Namespaces": [
            "default"
        ],
        "GranteeType": "User"
    },
    "PageNumber": 1,
    "PageSize": 10
}

返回参数

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

参数类型示例值描述
ItemsArray of AccessPolicy-RBAC 访问策略资源信息列表。
TotalCountInteger1符合条件的 RBAC 权限策略资源总数。
PageSizeInteger10每页显示的 RBAC 权限策略资源数。
PageNumberInteger1当前页码。

AccessPolicy

参数类型示例值描述
IdStringap********RBAC 权限策略资源 ID。

Status

String

Succeeded

RBAC 权限策略资源的授权状态。参数值说明:

  • Successed:授权成功。
  • Failed:授权失败。
MessageStringAccessDenied In Cluster A授权详细消息。
RoleNameStringvke:admin给被授权者授予的 RBAC 角色名称。系统预置的 RBAC 角色名称,请参见 RBAC 权限角色说明
ClusterIdStringccog93v*******RBAC 权限策略资源关联的集群 ID。参数值为all_clusters时,表示是当前账号下的所有集群。

GrantedAt

String

2022-05-06T02:49:19Z

RBAC 权限策略资源创建的时间。
标准 RFC3339 格式的 UTC+0 时间。

GranteeIdLong15******被授权者(IAM 用户或角色)的 ID。
NamespaceStringdefaultRBAC 权限策略资源关联的命名空间名称。参数值为空时,表示是 Cluster 级别的授权。

RevokedAt

String

2022-05-06T02:49:19Z

撤销授权的时间。
标准 RFC3339 格式的 UTC+0 时间。

GranteeType

String

Role

被授权者的类型,参数值说明:

  • User:IAM 用户。
  • Role:IAM 角色。

AuthorizedAt

String

2022-05-06T02:49:19Z

RBAC 权限策略资源被授权的时间。
标准 RFC3339 格式的 UTC+0 时间。

AuthorizerIdLong21******授权者的 ID。

IsCustomRole

Boolean

true

给被授权者授予的 RBAC 角色是否为自定义角色,参数值说明:

  • true:是自定义角色。
  • false:是系统预置的角色。
AuthorizerNameStringJohn授权者的名称。

AuthorizerType

String

Account

授权者的类型,参数值说明:

  • Account:火山引擎账号(主账号)。
  • User:IAM 用户。
  • Role:IAM 角色。
KubeRoleBindingNameString1-vke-admin-cluster-bindingRBAC 权限策略资源在 Kubernetes 中的对象名称。

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420********",
        "Action": "ListPermissions",
        "Version": "2022-05-12",
        "Service": "vke",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "Id": "ap********",
                "Status": "Succeeded",
                "Message": "AccessDenied In Cluster A",
                "RoleName": "vke:admin",
                "ClusterId": "ccog93v*******",
                "GrantedAt": "2022-05-06T02:49:19Z",
                "GranteeId": 1*,
                "Namespace": "default",
                "RevokedAt": "2022-05-06T02:49:19Z",
                "GranteeType": "Role",
                "AuthorizedAt": "2022-05-06T02:49:19Z",
                "AuthorizerId": 2*,
                "IsCustomRole": true,
                "AuthorizerName": "John",
                "AuthorizerType": "",
                "KubeRoleBindingName": "1-vke-admin-cluster-binding"
            }
        ],
        "TotalCount": 1,
        "PageSize": 10,
        "PageNumber": 1
    }
}

错误码

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