API docs by Redocly

VEGA 引擎 · 目录健康检查调度 API (0.1.0)

Download OpenAPI specification:

Vega Backend Catalog health-check schedule API.

Each physical Catalog has one health-check schedule. The schedule is an independent child resource and is not embedded in Catalog detail or list responses. It can be created with a physical Catalog through health_check_schedule; subsequent reads and updates use the dedicated endpoints defined here.

Every external endpoint has a matching internal version under /api/vega-backend/in/v1 with identical request and response structures. Only authentication differs. This document describes external APIs only.

Get a Catalog health-check schedule

Supported only for physical Catalogs and requires view_detail on the Catalog.

Authorizations:
OAuth2
path Parameters
id
required
string

physical Catalog ID

Responses

Response samples

Content type
application/json
{
  • "catalog_id": "string",
  • "mode": "inherit",
  • "cron_expr": "string",
  • "last_run": 0,
  • "next_run": 0,
  • "creator": {
    },
  • "create_time": 0,
  • "updater": {
    },
  • "update_time": 0
}

Update a Catalog health-check schedule

Supported only for physical Catalogs and requires modify on the Catalog. DELETE and separate enable/disable endpoints are not supported. Use mode=inherit, enabled, or disabled for full state transitions.

expected_update_time is required for optimistic concurrency control. Use update_time from the latest query response. A concurrent update causes a 409 response. VegaBackend.CatalogHealthCheckSchedule.UpdateConflict。

Authorizations:
OAuth2
path Parameters
id
required
string

physical Catalog ID

Request Body schema: application/json
required
expected_update_time
required
integer <int64> >= 1

Required optimistic-lock version for standalone PUT, taken from update_time in the latest query response

mode
required
string
Enum: "inherit" "enabled" "disabled"

inherit uses the platform default Cron from ConfigMap and clears the custom Cron; enabled uses the Cron in this request; disabled stops the schedule. Setting disabled with PUT preserves an existing custom Cron.

cron_expr
string non-empty

Health-check Cron expression required only when mode=enabled; adjacent runs must be at least one hour apart. PUT with mode=disabled ignores this field and preserves the existing custom Cron

Responses

Request samples

Content type
application/json
{
  • "expected_update_time": 1,
  • "mode": "inherit",
  • "cron_expr": "string"
}

Response samples

Content type
application/json
{
  • "catalog_id": "string",
  • "mode": "inherit",
  • "cron_expr": "string",
  • "last_run": 0,
  • "next_run": 0,
  • "creator": {
    },
  • "create_time": 0,
  • "updater": {
    },
  • "update_time": 0
}