批量授权
功能介绍
批量授权接口。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/{project_id}/instances/{instance_id}/policies/grant
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目编号。获取方法，请参见获取项目ID。 |
|
instance_id |
是 |
String |
LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
Array of strings |
租户token。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
principal_list |
是 |
Array of Principal objects |
主体信息。 |
|
resource |
是 |
ResourceInfo object |
资源信息。 |
|
effect |
是 |
Boolean |
拒绝/允许。 |
|
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。 枚举值：
|
|
conditions |
否 |
String |
条件。 |
|
data_filter |
否 |
String |
行过滤。 |
|
data_mask |
否 |
String |
列掩码。 |
|
data_mask_type |
否 |
String |
data mask type：REDACT修订， HASH哈希加密，PARTIAL_MASK部分掩码，NULLIFY用NULL值替换原值，UNMASKED原样显示，DATA_ONLY_SHOW_YEAR仅显示日期字符串的年份部分，CUSTOM自定义脱敏规则。 枚举值：
|
|
parameters |
否 |
Map<String,String> |
参数。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
principal_type |
是 |
String |
主体类型： USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。 枚举值：
|
|
principal_source |
是 |
String |
主体来源： IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。 枚举值：
|
|
principal_name |
是 |
String |
主体名称。只能包含中文、字母、数字和_-.特殊字符，且长度为1~49个字符。principal_name支持中划线'-'字符，但是对Principal进行授权时不支持'-'字符，可通过将有中划线的用户绑定到相关角色进行授权。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
catalogs |
否 |
Array of CatalogInfo objects |
catalog信息。 |
|
uris |
否 |
Array of strings |
URI，路径地址。 |
|
type |
是 |
String |
资源类型：CATALOG、DATABASE、TABLE、COLUMN、FUNC、MODEL、DATASET、URI。 枚举值：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
databases |
否 |
Array of DatabaseInfo objects |
子数据库信息。 |
|
name |
是 |
String |
catalog名。 |
|
models |
否 |
Array of ModelInfo objects |
子模型信息。 |
|
datasets |
否 |
Array of DatasetInfo objects |
子数据集信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。 |
|
tables |
否 |
Array of TableInfo objects |
子表信息。 |
|
functions |
否 |
Array of FunctionInfo objects |
子方法信息。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
policies |
Array of LakeFormationPolicy objects |
lakecat策略信息。 |
|
page_info |
PagedInfo object |
分页信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
项目ID。 |
|
instance_id |
String |
实例ID。 |
|
principal_type |
String |
主体类型：USER-用户、GROUP-组、ROLE-角色、SHARE-共享、OTHER-其它。 枚举值：
|
|
principal_source |
String |
主体来源：IAM-云、SAML-联邦、LDAP-权限策略、LOCAL-本地、AGENT-委托、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。 枚举值：
|
|
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。 枚举值：
|
|
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-列掩码权限策略。 枚举值：
|
|
obs_access_label |
String |
OBS Access Label, 描述了该条LakeFormation权限 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
catalogs |
Array of CatalogInfo objects |
catalog信息。 |
|
uris |
Array of strings |
URI，路径地址。 |
|
type |
String |
资源类型：CATALOG、DATABASE、TABLE、COLUMN、FUNC、MODEL、DATASET、URI。 枚举值：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
databases |
Array of DatabaseInfo objects |
子数据库信息。 |
|
name |
String |
catalog名。 |
|
models |
Array of ModelInfo objects |
子模型信息。 |
|
datasets |
Array of DatasetInfo objects |
子数据集信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
数据库名称。只能包含中文、字母、数字、下划线、中划线，且长度为1~128个字符。 |
|
tables |
Array of TableInfo objects |
子表信息。 |
|
functions |
Array of FunctionInfo objects |
子方法信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
column_name |
Array of strings |
列名称。只能包含中文、字母、数字和_-+*(), 特殊字符，且长度为1~767个字符。 |
|
filter |
String |
是否排除：Include包含，Exclude排除。 枚举值：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
current_count |
Integer |
本次返回的对象个数。最小值为0，最大值为2000。 |
|
next_marker |
String |
下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。 |
|
previous_marker |
String |
上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码： 404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
solution_msg |
String |
解决方案描述。 |
请求示例
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/policies/grant
{
"principal_list" : [ {
"principal_type" : "USER",
"principal_source" : "IAM",
"principal_name" : "user1"
} ],
"resource" : {
"catalogs" : [ {
"databases" : [ {
"name" : "db1",
"tables" : [ {
"columns" : {
"column_name" : [ ],
"filter" : "string"
},
"name" : "tb1"
} ],
"functions" : [ {
"name" : "string"
} ]
} ],
"name" : "catalog1"
} ],
"uris" : [ "string" ],
"type" : "CATALOG"
},
"effect" : true,
"permissions" : [ "ALTER,DROP" ],
"grant_able_permissions" : [ "ALTER,DROP" ],
"conditions" : "ip=127.0.0.1",
"data_filter" : "c1 < 0",
"data_mask" : "show last 4",
"data_mask_type" : "PARTIAL_MASK"
}
响应示例
状态码： 200
OK
{
"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:INCLUDE:c1",
"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 |
|
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
408 |
Request Timeout |
|
500 |
Internal Server Error |
错误码
请参见错误码。
