Discover the Iceberg REST service endpoint

GET 
/system/iceberg-rest

Reports the endpoint of the Iceberg REST service running as an auxiliary service of this Gravitino server, so that clients which already connect to the Gravitino server, such as the Trino connector, can discover it instead of configuring it separately. The reported 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. When gravitino.iceberg-rest.advertised-uri is configured, 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 marked Cache-Control: no-store.

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 Iceberg REST service endpoint

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

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

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

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