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

取消批量授权

功能介绍

批量取消授权接口。

调试

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

URI

POST /v1/{project_id}/instances/{instance_id}/policies/revoke

表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参数

参数

是否必选

参数类型

描述

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。

枚举值:

  • 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

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自定义脱敏规则。

枚举值:

  • REDACT

  • HASH

  • PARTIAL_MASK

  • NULLIFY

  • UNMASKED

  • DATA_ONLY_SHOW_YEAR

  • CUSTOM

parameters

Map<String,String>

参数。

表4 Principal

参数

是否必选

参数类型

描述

principal_type

String

主体类型: USER-用户、 GROUP-组、 ROLE-角色、 SHARE-共享、 OTHER-其它。

枚举值:

  • USER

  • GROUP

  • ROLE

  • SHARE

  • OTHER

principal_source

String

主体来源: IAM-云用户、 SAML-联邦、 LDAP ld-用户、 LOCAL-本地用户、 AGENTTENANT-委托、 OTHER-其它。

枚举值:

  • IAM

  • SAML

  • LDAP

  • LOCAL

  • AGENTTENANT

  • OTHER

principal_name

String

主体名称。只能包含中文、字母、数字和_-.特殊字符,且长度为1~49个字符。principal_name支持中划线'-'字符,但是对Principal进行授权时不支持'-'字符,可通过将有中划线的用户绑定到相关角色进行授权。

表5 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

表6 CatalogInfo

参数

是否必选

参数类型

描述

databases

Array of DatabaseInfo objects

子数据库信息。

name

String

catalog名。

models

Array of ModelInfo objects

子模型信息。

datasets

Array of DatasetInfo objects

子数据集信息。

表7 DatabaseInfo

参数

是否必选

参数类型

描述

name

String

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

tables

Array of TableInfo objects

子表信息。

functions

Array of FunctionInfo objects

子方法信息。

表8 TableInfo

参数

是否必选

参数类型

描述

columns

ColumnInfo object

子列信息。

name

String

表名称。

表9 ColumnInfo

参数

是否必选

参数类型

描述

column_name

Array of strings

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

filter

String

是否排除:Include包含,Exclude排除。

枚举值:

  • Include

  • Exclude

表10 FunctionInfo

参数

是否必选

参数类型

描述

name

String

函数名称。

表11 ModelInfo

参数

是否必选

参数类型

描述

name

String

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

表12 DatasetInfo

参数

是否必选

参数类型

描述

name

String

数据集名称。只能包含数字、字母、下划线,且长度为1~256。

响应参数

状态码: 400

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码: 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/policies/revoke

{
  "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"
}

响应示例

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

错误码

请参见错误码

相关文档