Readiness check

GET 
/health/ready

Returns 200 when the entity store is reachable within the configured probe timeout. Returns 503 when the entity store is unavailable or slow. Use this for Kubernetes readiness probes to control traffic routing. This endpoint is exempt from authentication so probes can reach it without credentials. A root-level alias at /health/ready (outside the /api base path) is also available for GTMs that require probes at well-known root paths.

Responses

200

Health check result

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Response code, 0 for success

status stringrequired

Possible values: [UP, DOWN]

Aggregate health status

checks

object[]

required

Per-component check results

Array [

name stringrequired

Name of the component being checked

status stringrequired

Possible values: [UP, DOWN]

Status of the component

details

object

Optional diagnostic details about the check result

property name* string

]

Example (from schema)

{
  "code": 0,
  "status": "UP",
  "checks": [
    {
      "name": "entityStore",
      "status": "UP",
      "details": {}
    }
  ]
}

HealthUp

{
  "code": 0,
  "status": "UP",
  "checks": [
    {
      "name": "httpServer",
      "status": "UP",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "UP",
      "details": {}
    }
  ]
}

HealthDown

{
  "code": 0,
  "status": "DOWN",
  "checks": [
    {
      "name": "httpServer",
      "status": "UP",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "DOWN",
      "details": {
        "reason": "timeout"
      }
    }
  ]
}

503

Health check result

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Response code, 0 for success

status stringrequired

Possible values: [UP, DOWN]

Aggregate health status

checks

object[]

required

Per-component check results

Array [

name stringrequired

Name of the component being checked

status stringrequired

Possible values: [UP, DOWN]

Status of the component

details

object

Optional diagnostic details about the check result

property name* string

]

Example (from schema)

{
  "code": 0,
  "status": "UP",
  "checks": [
    {
      "name": "entityStore",
      "status": "UP",
      "details": {}
    }
  ]
}

HealthUp

{
  "code": 0,
  "status": "UP",
  "checks": [
    {
      "name": "httpServer",
      "status": "UP",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "UP",
      "details": {}
    }
  ]
}

HealthDown

{
  "code": 0,
  "status": "DOWN",
  "checks": [
    {
      "name": "httpServer",
      "status": "UP",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "DOWN",
      "details": {
        "reason": "timeout"
      }
    }
  ]
}

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