文档首页/ 湖仓构建 LakeFormation/ API参考/ API/ LakeCat/ 授权管理/ 查询策略

更新时间：2024-10-22 GMT+08:00

查看PDF

查询策略

功能介绍

通过过滤条件查询接口。

调试

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

URI

GET /v1/{project_id}/instances/{instance_id}/policies/show

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目编号。获取方法，请参见获取项目ID。
instance_id	是	String	LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

表2 Query参数
参数	是否必选	参数类型	描述
filter	否	String	权限策略过滤表达式，暂不支持。
obs_authorized_location	否	String	obs路径权限策略作为查询条件, 查询所有包含该obs路径的元数据权限。
resource_name	否	String	元数据资源全名。长度为1~1000个字符。
resource_type	否	String	元数据资源类型：CATALOG、DATABASE、TABLE、FUNC、MODEL、DATASET、COLUMN、URI。枚举值： CATALOG DATABASE TABLE FUNC MODEL DATASET COLUMN URI
principal_source	否	String	授权主体来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托用户。枚举值： IAM SAML LDAP LOCAL AGENTTENANT
principal_type	否	String	授权主体类型：USER-用户、GROUP-组、ROLE-角色、SHARE-共享、OTHER-其它。枚举值： USER GROUP ROLE SHARE OTHER
principal_name	否	String	授权主体名称。长度为1~1000个字符。
limit	否	Integer	查询返回条数。默认值为1000。最小值为1，最大值为2147483647。
marker	否	String	查询的起始记录ID。最小长度为0，最大长度为256。
reverse_page	否	Boolean	是否倒序查询。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	Array of strings	租户token。

响应参数

状态码： 200

表4 响应Header参数
参数	参数类型	描述
X-request-id	String	请求ID，定位辅助信息。

表5 响应Body参数
参数	参数类型	描述
policies	Array of LakeFormationPolicy objects	lakecat策略信息。
page_info	PagedInfo object	分页信息。

表6 LakeFormationPolicy
参数	参数类型	描述
project_id	String	项目ID。
instance_id	String	实例ID。
principal_type	String	主体类型：USER-用户、GROUP-组、ROLE-角色、SHARE-共享、OTHER-其它。枚举值： USER GROUP ROLE SHARE OTHER
principal_source	String	主体来源：IAM-云、SAML-联邦、LDAP-权限策略、LOCAL-本地、AGENT-委托、AGENTTENANT-委托、OTHER-其它。枚举值： IAM SAML LDAP LOCAL AGENTTENANT OTHER
principal_name	String	主体名。
resource	ResourceInfo object	资源信息。
resource_name	String	要求用点分格式进行分割。
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。枚举值： 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。枚举值： 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
created_time	Long	创建时间。
condition	String	条件信息。
obligation	String	obligation，义务，当前包含data filter和data mask。
authorization_paths	Array of strings	授权路径列表。
parameters	Map<String,String>	参数。
access_policy_type	String	权限策略类型：DEFAULT-普通策略、ROW_FILTER-行过滤权限策略、DATA_MASK-列掩码权限策略。枚举值： DEFAULT ROW_FILTER DATA_MASK
obs_access_label	String	OBS Access Label, 描述了该条LakeFormation权限

表7 ResourceInfo
参数	参数类型	描述
catalogs	Array of CatalogInfo objects	catalog信息。
uris	Array of strings	URI，路径地址。
type	String	资源类型：CATALOG、DATABASE、TABLE、COLUMN、FUNC、MODEL、DATASET、URI。枚举值： CATALOG DATABASE TABLE COLUMN FUNC MODEL DATASET URI

表8 CatalogInfo
参数	参数类型	描述
databases	Array of DatabaseInfo objects	子数据库信息。
name	String	catalog名。
models	Array of ModelInfo objects	子模型信息。
datasets	Array of DatasetInfo objects	子数据集信息。

表9 DatabaseInfo
参数	参数类型	描述
name	String	数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。
tables	Array of TableInfo objects	子表信息。
functions	Array of FunctionInfo objects	子方法信息。

**表10** TableInfo
参数	参数类型	描述
columns	ColumnInfo object	子列信息。
name	String	表名称。

**表11** ColumnInfo
参数	参数类型	描述
column_name	Array of strings	列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符。
filter	String	是否排除：Include包含，Exclude排除。枚举值： Include Exclude

**表12** FunctionInfo
参数	参数类型	描述
name	String	函数名称。

**表13** ModelInfo
参数	参数类型	描述
name	String	模型名称。只能包含字母、数字、下划线、中划线，且长度为1~256个字符。

**表14** DatasetInfo
参数	参数类型	描述
name	String	数据集名称。只能包含数字、字母、下划线，且长度为1~256。

**表15** PagedInfo
参数	参数类型	描述
current_count	Integer	本次返回的对象个数。最小值为0，最大值为2000。
next_marker	String	下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。
previous_marker	String	上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。

状态码： 400

**表16** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
solution_msg	String	解决方案描述。

状态码： 404

**表17** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
solution_msg	String	解决方案描述。

状态码： 500

**表18** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
solution_msg	String	解决方案描述。

请求示例

GET https://{endpoint}/v1/{project_id}/instances/{instance_id}/policies/show

响应示例

状态码： 200

{
  "policies" : [ {
    "project_id" : "41aa75443xxxxxx2c6afaaa40cc046",
    "instance_id" : "51c51596-2e97-47bf-xxxx-0fc728c04ced",
    "principal_type" : "USER",
    "principal_source" : "IAM",
    "principal_name" : "user1",
    "resource" : {
      "catalogs" : [ {
        "databases" : [ {
          "name" : "db1",
          "tables" : [ { } ],
          "functions" : [ { } ]
        } ],
        "name" : "catalog1"
      } ],
      "uris" : [ "string" ],
      "type" : "CATALOG"
    },
    "resource_name" : "string",
    "permissions" : [ "DROP", "ALTER" ],
    "grant_able_permissions" : [ "ALTER" ],
    "created_time" : 0,
    "condition" : "ip=127.0.0.1",
    "obligation" : "DATAFILTER:c1<10;DATAMASK:PARTIAL_MASK:show last 4",
    "authorization_paths" : [ "obs://location/uri/" ]
  } ],
  "page_info" : {
    "current_count" : 2000,
    "next_marker" : "006f492b-xxxx",
    "previous_marker" : "003e6eba-xxxx"
  }
}

状态码： 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

错误码

请参见错误码。

父主题： 授权管理

上一篇：取消批量授权

下一篇：批量鉴权

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消