GrantPermissions - Data Lake Formation - Alibaba Cloud Documentation Center

Grants permissions on resources to DLF users and roles.

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:GrantPermissions

create

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
Body	object	No	The HTTP request body, in the JSON format.
Type	string	Yes	The authorization type. Only Hive is supported.	Hive
MetaResource	MetaResource	Yes	The metadata resource to grant permissions.
Accesses	Accesses	Yes	The access permissions to grant.
DelegateAccesses	Accesses	Yes	The grantable access permissions.
Principal	Principal	Yes	The user or role to which permissions are granted. The format is as follows: RAM user: acs:ram::[accountId]:user/[userName]. RAM role: acs:ram::[accountId]:role/[roleName]. Data lake role: acs:dlf::[accountId]:role/[roleName].
CatalogId	string	No	The ID of the catalog.	主账号ID或空字符串

Response elements

Element	Type	Description	Example
	object	The response body.
Code	string	The description of the status code.	OK
Message	string	The returned message.	.
RequestId	string	The request ID.	4912024D-2A06-5E9F-9667-35D9319917D7
Success	boolean	Indicates whether the call is successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": ".",
  "RequestId": "4912024D-2A06-5E9F-9667-35D9319917D7",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.