文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat类API/ 授权管理/ 获取权限集合 - ListPermissionSet
更新时间：2026-03-24 GMT+08:00
查看PDF
分享

获取权限集合 - ListPermissionSet

功能介绍

获取权限集合。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/instances/{instance_id}/policies/permission-set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。
表3 请求Body参数

参数

是否必选

参数类型

描述

resource

是

ResourceInput object

资源信息。

principal_list

否

Array of AssociatePrincipal objects

授权主体信息。
表4 ResourceInput

参数

是否必选

参数类型

描述

resource_type

是

String

元数据资源类型：CATALOG、DATABASE、TABLE、FUNC、MODEL、DATASET、COLUMN、URI。

catalog

否

String

catalog名称。只能包含字母、数字和下划线，且长度为1~256个字符。

database

否

String

数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1到128个字符。

function

否

String

函数名称。只能包含字母、数字和下划线，且长度为1~256个字符。

table

否

String

表名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~256个字符。

column

否

String

列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符。

uri

否

String

URI

columns

否

Array of strings

列名称列表。

model

否

String

模型名称。

dataset

否

String

数据集名称。
表5 AssociatePrincipal

参数

是否必选

参数类型

描述

principal_type

是

String

主体类型：

USER-用户、

GROUP-组、

ROLE-角色、

SHARE-共享、

OTHER-其它。

principal_source

是

String

主体来源：

IAM-云用户、

SAML-联邦、

LDAP ld-用户、

LOCAL-本地用户、

AGENTTENANT-委托、

OTHER-其它。

principal_name

是

String

主体名称。长度为1~128个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

principal_permissions

Array of PrincipalPermissions objects

授权主体权限
表7 PrincipalPermissions

参数

参数类型

描述

principal

AssociatePrincipal object

授权主体

permissions

Array of strings

权限列表：ALL、CREATE、ALTER、DROP、DESCRIBE、EXEC、CREATE_DATABASE、LIST_DATABASE、CREATE_TABLE、LIST_TABLE、CREATE_FUNC、LIST_FUNC、REGISTER_MODEL、LIST_MODEL、CREATE_MODEL、CREATE_DATASET、LIST_DATASET、INSERT、UPDATE、DELETE、SELECT、READ、WRITE、OPERATE、INTROSPECTION、SOURCES、DICT GET、TRUNCATE、 OPTIMIZE、CREATE TEMPORARY TABLE、CREATE DICTIONARY、CREATE VIEW、SHOW DATABASES、SHOW TABLES、SHOW DICTIONARIES、SHOW COLUMNS、DROP DATABASE、DROP VIEW、DROP DICTIONARY、DROP TABLE、ALTER TABLE、ALTER UPDATE、ALTER DELETE、ALTER COLUMN、ALTER ADD COLUMN、ALTER DROP COLUMN、ALTER MODIFY COLUMN、ALTER COMMENT COLUMN、ALTER CLEAR COLUMN、 ALTER RENAME COLUMN、ALTER INDEX、ALTER ORDER BY、ALTER ADD INDEX、ALTER DROP INDEX、ALTER MATERIALIZE INDEX、ALTER CLEAR INDEX、ALTER CONSTRAINT、ALTER ADD CONSTRAINT、ALTER DROP CONSTRAINT、ALTER TTL、ALTER MATERIALIZE TTL、ALTER SETTINGS、ALTER MOVE PARTITION、ALTER FETCH PARTITION、ALTER FREEZE PARTITION、ALTER VIEW、ALTER VIEW REFRESH、ALTER VIEW MODIFY QUERY。

grant_able_permissions

Array of strings

可传递的权限列表：ALL、CREATE、ALTER、DROP、DESCRIBE、EXEC、CREATE_DATABASE、LIST_DATABASE、CREATE_TABLE、LIST_TABLE、CREATE_FUNC、LIST_FUNC、REGISTER_MODEL、LIST_MODEL、CREATE_MODEL、CREATE_DATASET、LIST_DATASET、INSERT,UPDATE、DELETE、SELECT、READ、WRITE、OPERATE、INTROSPECTION、SOURCES、DICT GET、 TRUNCATE、OPTIMIZE、CREATE TEMPORARY TABLE、CREATE DICTIONARY、CREATE VIEW、SHOW DATABASES、SHOW TABLES、SHOW DICTIONARIES、SHOW COLUMNS、DROP DATABASE、DROP VIEW、DROP DICTIONARY、DROP TABLE、ALTER TABLE、ALTER UPDATE、ALTER DELETE、ALTER COLUMN、ALTER ADD COLUMN、ALTER DROP COLUMN、ALTER MODIFY COLUMN、ALTER COMMENT COLUMN、ALTER CLEAR COLUMN、 ALTER RENAME COLUMN、ALTER INDEX、ALTER ORDER BY、ALTER ADD INDEX、ALTER DROP INDEX、ALTER MATERIALIZE INDEX、ALTER CLEAR INDEX、ALTER CONSTRAINT、ALTER ADD CONSTRAINT、ALTER DROP CONSTRAINT、ALTER TTL、ALTER MATERIALIZE TTL、ALTER SETTINGS、ALTER MOVE PARTITION、ALTER FETCH PARTITION、ALTER FREEZE PARTITION、ALTER VIEW、ALTER VIEW REFRESH、ALTER VIEW MODIFY QUERY。
表8 AssociatePrincipal

参数

参数类型

描述

principal_type

String

主体类型：

USER-用户、

GROUP-组、

ROLE-角色、

SHARE-共享、

OTHER-其它。

principal_source

String

主体来源：

IAM-云用户、

SAML-联邦、

LDAP ld-用户、

LOCAL-本地用户、

AGENTTENANT-委托、

OTHER-其它。

principal_name

String

主体名称。长度为1~128个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。

状态码：400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：401

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：403

表11 响应Body参数

参数

参数类型

描述

error

Error object

错误信息。

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。
表12 Error

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。

message

String

错误信息。

code

String

状态码。

状态码：404

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：408

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET /v1/{project_id}/instances/{instance_id}/policies/permission-set

{
  "resource" : {
    "resource_type" : "DATABASE",
    "catalog" : "catalog1",
    "database" : "db1"
  },
  "principal_list" : [ {
    "principal_type" : "USER",
    "principal_source" : "IAM",
    "principal_name" : "user1"
  } ]
}

响应示例

状态码：200

OK

{
  "principal_permissions" : [ {
    "principal" : {
      "principal_type" : "USER",
      "principal_source" : "IAM",
      "principal_name" : "user1"
    },
    "permissions" : [ "ALTER" ],
    "grant_able_permissions" : [ "ALTER" ]
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题： 授权管理

相关文档