POST api/v1/mirrors/status

This endpoint is used to get the status of a mirror. Status of the mirror could be:

  • STATUS_SETUP: The mirror is in setup flow, where it creates target tables and metadata tables.
  • STATUS_SNAPSHOT: The mirror is currently performing initial load.
  • STATUS_RUNNING: The mirror has completed initial load and is in the phase of CDC.
  • STATUS_PAUSED: The mirror is in CDC phase and is paused.
  • STATUS_PAUSING: The mirror is in CDC phase and is in the process of pausing.
  • STATUS_TERMINATED: The mirror has been deleted/terminated.
  • STATUS_UNKNOWN: The mirror is not found in the catalog, or its status cannot be obtained due to some issue.

Request Body

The request consists of the mirror name specified as flowJobName and includeFlowInfo as a boolean, which when set, will include in its response additional, non-status related information about the mirror such as mirror configuration and initial load information of tables.

flowJobName
string
required

The name of the mirror to get the status of.

includeFlowInfo
boolean

When set to true, will include in its response additional, non-status related information about the mirror such as mirror configuration and initial load information of tables.

Response Fields

flowJobName
string

The name of the mirror.

errorMessage
string

Error message if any.

currentFlowState
string

The current state of the mirror.

ok
boolean

Indicates if the request was successful.

Additional flow information when includeFlowInfo is set to true: