Associate policies with a metadata object

POST 
/metalakes/:metalake/objects/:metadataObjectType/:metadataObjectFullName/policies

Attaches policies to a metadata object and detaches others in one request, and returns the names of the policies attached directly to the object afterward. A policy listed in both policiesToAdd and policiesToRemove is left unchanged.

Sign in with a bearer token or a local user's password; see Authentication.

Request

Path Parameters

metalake stringrequired

The name of the metalake

metadataObjectType stringrequired

Possible values: [CATALOG, SCHEMA, FILESET, TABLE, VIEW, TOPIC, MODEL, FUNCTION]

The type of the metadata object. Policies can be associated with these types only; associating a policy with any other type fails with IllegalArgumentException. The server matches the value case-insensitively.

metadataObjectFullName stringrequired

The full name of the metadata object

application/json

Body

policiesToAdd string[]nullable

The names of the policies to attach

policiesToRemove string[]nullable

The names of the policies to detach

Responses

200

The names of the policies attached directly to the object after the change.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

names string[]

Example (from schema)

{
  "code": 0,
  "names": [
    "string"
  ]
}

NameListResponse

{
  "code": 0,
  "names": [
    "my_policy1",
    "my_policy2"
  ]
}

404

The metalake or the metadata object does not exist.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

NoSuchMetalakeException

{
  "code": 1003,
  "type": "NoSuchMetalakeException",
  "message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
    "..."
  ]
}

409

One of the policies to add is already attached to the object.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

PolicyAlreadyAssociatedException

{
  "code": 1004,
  "type": "PolicyAlreadyAssociatedException",
  "message": "Failed to operate policy(s) [my_policy] operation [ASSOCIATE] under metalake [my_test_metalake], reason [PolicyAlreadyAssociatedException]",
  "stack": [
    "org.apache.gravitino.exceptions.PolicyAlreadyAssociatedException: Policy my_policy already associated",
    "..."
  ]
}

5xx

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...