RevokePermissions - Data Lake Formation - Alibaba Cloud Documentation Center

Revokes permissions on resources from a DLF user or role.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dlf:RevokePermissions

delete

*All Resource

*

None

Request syntax

POST /api/metastore/auth/permissions/revoke HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Body	object	No	The JSON-formatted request body.
Type	string	Yes	The type of authorization to revoke. Only Hive is supported.	Hive
MetaResource	MetaResource	Yes	The metadata resource to revoke permissions from.
Accesses	Accesses	Yes	The access permissions to revoke.
DelegateAccesses	Accesses	No	The grantable access permissions that need to be revoked. This parameter is not available.
Principal	Principal	Yes	The user or role to revoke permissions from. Use one of the following formats: RAM user: acs:ram::[accountId]:user/[userName]. RAM role: acs:ram::[accountId]:role/[roleName]. DLF role: acs:dlf::[accountId]:role/[roleName].
CatalogId	string	No	The catalog ID.	1344371

Response elements

Element	Type	Description	Example
	object	The response body.
Code	string	The status code.	OK
Message	string	The returned message.	.
RequestId	string	The request ID.	7CB5765C-F209-5B10-8792-D2BE9156ABE8
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "7CB5765C-F209-5B10-8792-D2BE9156ABE8",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.