All Products
Search
Document Center

Data Lake Formation:BatchGrantPermissions

Last Updated:Sep 22, 2025

Grants permissions in a batch.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /dlf/v1/auth/permissions/{catalogId}/batchgrant HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

catalogId

string

No

The ID of the data catalog.

clg-paimon-xxxx

body

object

No

The request body.

permissions

array

No

The list of permissions.

Permission

No

A permission.

Response elements

Element

Type

Description

Example

object

Schema of Response

failurePermissions

array

The list of permissions that failed to be granted.

FailurePermission

A permission that failed to be granted.

success

boolean

Indicates whether the API call was successful. A value of true indicates success. A value of false indicates failure.

True

errorMessage

string

The error message. This parameter is returned only when success is false. If success is true, this parameter is empty.

Examples

Success response

JSON format

{
  "failurePermissions": [
    {
      "errorMessage": "",
      "errorCode": "",
      "permission": {
        "principal": "",
        "database": "",
        "view": "",
        "access": "",
        "columns": {
          "columnNames": [
            ""
          ],
          "excludedColumnNames": [
            ""
          ]
        },
        "function": "",
        "table": "",
        "resourceType": ""
      }
    }
  ],
  "success": true,
  "errorMessage": "空"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.