List metadata objects for policy

GET 
/metalakes/:metalake/policies/:policy/objects

Returns the metadata objects the policy is attached to directly, limited to the objects the caller can access.

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

Request

Path Parameters

metalake stringrequired

The name of the metalake

policy stringrequired

The name of the policy

Responses

200

The metadata objects the policy is attached to directly, limited to those the caller can access.

application/vnd.gravitino.v1+json

Schema

Schema

code int32

Possible values: [0]

Status code of the response

metadataObjects

object[]

A list of metadata objects

Array [

fullName string

The name of the metadata object, separated by dots

type string

Possible values: [catalog, schema, fileset, table, view, topic, model, function]

The type of the metadata object, one of the types a policy can be associated with. Responses return the value in lowercase.

]

Example (from schema)

{
  "code": 0,
  "metadataObjects": [
    {
      "fullName": "string",
      "type": "catalog"
    }
  ]
}

PolicyResponse

{
  "code": 0,
  "metadataObjects": [
    {
      "type": "catalog",
      "fullName": "my_catalog"
    },
    {
      "type": "schema",
      "fullName": "my_catalog.my_schema"
    },
    {
      "type": "table",
      "fullName": "my_catalog.my_schema.my_table"
    }
  ]
}

400

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

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": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

404

The metalake or the policy 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"
}

NoSuchPolicyException

{
  "code": 1003,
  "type": "NoSuchPolicyException",
  "message": "Failed to operate policy(s) [my_policy] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchPolicyException]",
  "stack": [
    "org.apache.gravitino.exceptions.NoSuchPolicyException: Policy my_policy does not exist",
    "..."
  ]
}

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...