list metadata objects for policy

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

list metadata objects for policy

Request

Path Parameters

metalake stringrequired

The name of the metalake

policy stringrequired

The name of the policy

Responses

200

Returns the list of metadata objects associated with specified policy

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, TABLE, FILESET, TOPIC, MODEL, COLUMN]

The type of the metadata object

]

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

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

404

Not Found - The specified 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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "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

A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.

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[]

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string",
  "stack": [
    "string"
  ]
}

Example

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

Loading...