查询符合条件的 RBAC 访问策略资源信息。 ## 请求说明 VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://www.volcengine.com/docs/6460/1899855) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://vke.cn\-beijing.volcengineapi.com?Action=ListPermissions&Version=2022\-05\-12 ## 调试 ## 请求参数调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见 [公共参数](https://www.volcengine.com/docs/6460/70904)。 |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |ListPermissions |接口名称。当前 API 的名称为 `ListPermissions`。 | |Version |String |是 |2022\-05\-12 |接口版本。当前 API 的版本为 `2022-05-12`。 | |Filter |Object of [ListPermissionsFilter](https://www.volcengine.com/docs/6460/1392459#listpermissionsfilter) |否 |\- |待查询访问策略资源的筛选条件。 | |PageNumber |Integer |否 |1 |分页查询时的起始页码，从 1 开始，默认为 1。 | |PageSize |Integer |否 |10 |分页查询时每页显示的记录数，取值：|\ | | | | ||\ | | | | |* 最小值：1|\ | | | | |* 最大值：100|\ | | | | |* 默认值：10 | ### ListPermissionsFilter |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Ids |Array of String |否 |["ap\*\*\*\*\*\*12"] |RBAC 权限策略资源的 ID 列表。调用 [GrantPermission](https://www.volcengine.com/docs/6460/1392460) 接口时，会返回 RBAC 权限策略资源的 ID。|\ | | | | |:::tip|\ | | | | ||\ | | | | |* 单次最多填写 100 个资源 ID。|\ | | | | |* 此参数为空数组时，筛选基于账号下的所有 RBAC 权限策略资源。|\ | | | | ||\ | | | | |:::| |Status |String |否 |Success |RBAC 权限访问策略资源的状态，取值如下：|\ | | | | ||\ | | | | |* **Success**：授权成功。|\ | | | | |* **Failed**：授权失败。|\ | | | | ||\ | | | | |:::tip|\ | | | | |传入多个状态时，状态间是逻辑「或」关系。|\ | | | | ||\ | | | | |:::| |RoleNames |Array of String |否 |["vke:admin"] |给被授权者授予的 RBAC 角色名称列表，取值说明如下：|\ | | | | ||\ | | | | |* 自定义的角色名称：您自定义的角色名称。|\ | | | | |* 系统预置的角色名称：系统预置的 RBAC 角色名称，详情请参见 [RBAC 权限角色说明](https://www.volcengine.com/docs/6460/1129837)。|\ | | | | ||\ | | | | |:::tip|\ | | | | |单次最多填写 100 个 RBAC 角色名称。|\ | | | | ||\ | | | | |:::| |ClusterIds |Array of String |否 |[ccog93v\*\*\*\*\*\*\*] |RBAC 权限策略资源关联的集群 ID 列表。可以调用 [ListClusters](https://www.volcengine.com/docs/6460/115190) 接口，获取集群 ID。|\ | | | | |:::tip|\ | | | | |单次最多填写 100 个集群 ID。|\ | | | | ||\ | | | | |:::| |GranteeIds |Array of Long |否 |[153\*\*\*\*\*\*] |被授权者的 ID。默认为 IAM 用户 ID，也可以填写 IAM 角色 ID。|\ | | | | |:::warning|\ | | | | ||\ | | | | |* 如填写 IAM 角色 ID，必须还要传入 **GranteeType** 参数值。|\ | | | | |* 单次最多填写 100 个 ID。|\ | | | | |* 可以调用 [ListUsers](https://www.volcengine.com/docs/6257/65008) 或 [ListRoles](https://www.volcengine.com/docs/6257/65019) 接口，获取 ID。|\ | | | | ||\ | | | | |:::| |Namespaces |Array of String |否 |["default"] |RBAC 权限策略资源关联的命名空间列表。可以登录 [容器服务控制台](https://console.volcengine.com/vke)，查看命名空间名称。 | |GranteeType |String |否 |User |被授权者的类型，取值如下：|\ | | | | ||\ | | | | |* **User**：IAM 用户。|\ | | | | |* **Role**：IAM 角色。 | ## 请求示例 ```json POST /?Action=ListPermissions&Version=2022-05-12 HTTP/1.1 Content-Type: application/json { "Filter": { "Ids": [ "ap******12" ], "Status": "Success", "RoleNames": [ "vke: admin" ], "Namespaces": [ "default" ], "GranteeType": "User" }, "PageNumber": 1, "PageSize": 10 } ``` ## 返回参数本接口返回参数如下表所示，公共返回参数请参见 [返回结果](https://www.volcengine.com/docs/6460/79674)。 |参数 |类型 |示例值 |描述 | |---|---|---|---| |Items |Array of [AccessPolicy](https://www.volcengine.com/docs/6460/1392459#accesspolicy) |\- |RBAC 访问策略资源信息列表。 | |TotalCount |Integer |1 |符合条件的 RBAC 权限策略资源总数。 | |PageSize |Integer |10 |每页显示的 RBAC 权限策略资源数。 | |PageNumber |Integer |1 |当前页码。 | ### AccessPolicy |参数 |类型 |示例值 |描述 | |---|---|---|---| |Id |String |ap\*\*\*\*\*\*\*\* |RBAC 权限策略资源 ID。 | |Status |String |Succeeded |RBAC 权限策略资源的授权状态。参数值说明：|\ | | | ||\ | | | |* **Success**：授权成功。|\ | | | |* **Failed**：授权失败。 | |Message |String |AccessDenied In Cluster A |授权详细消息。 | |RoleName |String |vke:admin |给被授权者授予的 RBAC 角色名称。系统预置的 RBAC 角色名称，请参见 [RBAC 权限角色说明](https://www.volcengine.com/docs/6460/1129837)。 | |ClusterId |String |ccog93v\*\*\*\*\*\*\* |RBAC 权限策略资源关联的集群 ID。参数值为`all_clusters`时，表示是当前账号下的所有集群。 | |GrantedAt |String |2022\-05\-06T02:49:19Z |RBAC 权限策略资源创建的时间。|\ | | | |标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | |GranteeId |Long |15\*\*\*\*\*\* |被授权者（IAM 用户或角色）的 ID。 | |Namespace |String |default |RBAC 权限策略资源关联的命名空间名称。参数值为空时，表示是 Cluster 级别的授权。 | |RevokedAt |String |2022\-05\-06T02:49:19Z |撤销授权的时间。|\ | | | |标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | |GranteeType |String |Role |被授权者的类型，参数值说明：|\ | | | ||\ | | | |* **User**：IAM 用户。|\ | | | |* **Role**：IAM 角色。 | |AuthorizedAt |String |2022\-05\-06T02:49:19Z |RBAC 权限策略资源被授权的时间。|\ | | | |标准 [RFC3339](https://tools.ietf.org/html/rfc3339) 格式的 UTC+0 时间。 | |AuthorizerId |Long |21\*\*\*\*\*\* |授权者的 ID。 | |IsCustomRole |Boolean |true |给被授权者授予的 RBAC 角色是否为自定义角色，参数值说明：|\ | | | ||\ | | | |* **true**：是自定义角色。|\ | | | |* **false**：是系统预置的角色。 | |AuthorizerName |String |John |授权者的名称。 | |AuthorizerType |String |Account |授权者的类型，参数值说明：|\ | | | ||\ | | | |* **Account**：火山引擎账号（主账号）。|\ | | | |* **User**：IAM 用户。|\ | | | |* **Role**：IAM 角色。 | |KubeRoleBindingName |String |1\-vke\-admin\-cluster\-binding |RBAC 权限策略资源在 Kubernetes 中的对象名称。 | ## 返回示例 ```json { "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 } } ``` ## 错误码本接口无专有错误码，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6460/118978)。