Get Iceberg REST service endpoint

GET 
/system/iceberg-rest

Returns the URI of the Iceberg REST service that runs as an auxiliary service of this server, so that clients such as the Trino connector can discover it instead of configuring it. The uri is null when the service is not registered, does not use the dynamic catalog config provider, or serves a different metalake than the requested one.

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

Request

Query Parameters

metalake string

The metalake the caller intends to route through the Iceberg REST service. When omitted or blank, the endpoint is reported regardless of which metalake it serves.

Responses

200

The URI of the Iceberg REST service, or a null uri when no matching service serves the requested metalake.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Response code, 0 for success

uri stringnullable

The Iceberg REST service endpoint, or null when the service is not running or does not serve the requested metalake. When gravitino.iceberg-rest.advertised-uri is set, it is reported as-is; otherwise the endpoint is derived from the service's listener configuration, and a wildcard listener host is replaced with the host the caller used to reach the Gravitino server. The response is therefore sent with Cache-Control: no-store.

Example (from schema)

{
  "code": 0,
  "uri": "http://gravitino-host:9001/iceberg"
}

IcebergRESTServiceAvailable

{
  "code": 0,
  "uri": "http://gravitino-host:9001/iceberg"
}

IcebergRESTServiceUnavailable

{
  "code": 0,
  "uri": null
}

4XX

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"
}

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