Load the metadata properties for a namespace

GET 
/v1/:prefix/namespaces/:namespace

Return all stored metadata properties for a given namespace

Request

Path Parameters

prefix stringrequired

The catalog name in Gravitino, as returned in defaults.prefix by GET /v1/config

namespace stringrequired

A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override namespace-separator, which defaults to the unit separator 0x1F byte (url encoded %1F). To be compatible with older clients, servers must use both the advertised separator and 0x1F as valid separators when decoding namespaces. The namespace-separator should be provided in a url encoded form.

Examples:

singlepart_namespace

Example: accounting

multipart_namespace

Example: accounting%1Ftax

Responses

200

Returns a namespace, as well as any properties stored on the namespace if namespace properties are supported by the server.

application/json

Schema

Schema

namespace string[]required

Reference to one or more levels of a namespace

properties

object

nullable

Properties stored on the namespace, if supported by the server. If the server does not support namespace properties, it should return null for this field. If namespace properties are supported, but none are set, it should return an empty object.

property name* string

Example (from schema)

{
  "namespace": [
    "accounting",
    "tax"
  ],
  "properties": {
    "owner": "Ralph",
    "transient_lastDdlTime": "1452120468"
  }
}

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/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Malformed request",
    "type": "BadRequestException",
    "code": 400
  }
}

401

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 401
  }
}

403

Forbidden. Authenticated user does not have the necessary permissions.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Not authorized to make this request",
    "type": "NotAuthorizedException",
    "code": 403
  }
}

404

Not Found - Namespace not found

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

NoSuchNamespaceExample

The requested namespace does not exist

{
  "error": {
    "message": "The given namespace does not exist",
    "type": "NoSuchNamespaceException",
    "code": 404
  }
}

419

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Credentials have timed out",
    "type": "AuthenticationTimeoutException",
    "code": 419
  }
}

503

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

application/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Slow down",
    "type": "SlowDownException",
    "code": 503
  }
}

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/json

Schema

Schema

error

object

required

JSON error payload returned in a response with further details on the error

message stringrequired

Human-readable error message

type stringrequired

Internal type definition of the error

code integerrequired

Possible values: >= 400 and <= 600

HTTP response code

stack string[]

Example (from schema)

{
  "error": {
    "message": "The server does not support this operation",
    "type": "UnsupportedOperationException",
    "code": 406
  }
}

Example

{
  "error": {
    "message": "Internal Server Error",
    "type": "InternalServerError",
    "code": 500
  }
}

Loading...