Obter todos os trabalhos de migração

OBTER /jobs

Obter todos os trabalhos de migração

parâmetros de query

  • sort string

    Ordem na qual recuperar os resultados

    O formato deve corresponder ao seguinte padrão: ^\w+,(DESC|ASC)$. O valor padrão é submittedAt,DESC.

  • limit inteiro

    Limite os resultados

    O valor mínimo é 0.

  • type string

    Filtrar trabalhos para apenas de um tipo de tarefa específico

    O valor é IN_PROGRESS.

  • projectId string

    Filtrar tarefas por projectId

    O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

Respostas

  • 200 aplicação/json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • id string Obrigatório

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • projectId string Obrigatório

      O formato deve corresponder ao seguinte padrão: ^[A-Za-z0-9\-]+$.

    • Status string Obrigatório

      Os valores são NOT_STARTED, RUNNING, FAILED, CANCELLING, CANCELLED, COMPLETED, CLEANING_UP ou PAUSED.

    • status do cdc string

      Os valores são NOT_STARTED, RUNNING, COMPLETING, COMPLETED, FAILED, CANCELLED ou PAUSED. O valor padrão é NOT_STARTED.

    • verifyJobId string
    • opções objeto Obrigatório

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos de opções Mostrar atributos de opções objeto
      • Descartar coleções booleano

        O valor padrão é false.

      • Modo string Obrigatório

        Os valores são SNAPSHOT, CDC, INCREMENTAL ou VERIFICATION.

      • truncationReportMode string

        Os valores são FAIL, WARN ou SKIP.

      • errorHandling string

        define se os erros do Debezium lançarão uma exceção ou apenas serão registrados. https://debezium.io/documentation/reference/stable/connectors/mysql.html#mysql-property-event-processing-failure-handling-mode

        Os valores são FAIL, WARN ou SKIP.

      • tolerância a erros inteiro

        O número de falhas (no nível do registro) que devem ser toleradas antes de encerrar a migração. O valor é estritamente maior ou igual a .

        O valor mínimo é 0.

      • incrementalSnapshotOptions objeto

        Opções para o modo de migração INCREMENTAL apenas.

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos incrementalSnapshotOptions Mostrar atributos incrementalSnapshotOptions objeto
        • signalingTable string

          Tabela de sinalização no banco de dados de origem usada para coordenar o snapshot incremental.

        • chunkSize inteiro

          Linhas por parte de snapshot incremental (Debezium incremental.snapshot.chunk.size). Quando omitido, o padrão do Debezium de 1024 se aplica. Partes maiores copiam mais rapidamente, mas mantêm mais linhas na memória por janela de parte aberta.

          O valor mínimo é 1, o valor máximo é 100000.

    • jdbcConnectionString string
    • mongoDbConnectionString string
    • submittedAt string(data-hora) Obrigatório
    • estatísticas objeto

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos de estatísticas Mostrar atributos de estatísticas objeto
      • startedAt string(data-hora)
      • decorridos segundos integer(int64)
      • remainingTableCount inteiro
      • ProcessingTables array[string]
      • migratedTables array[string]

        Tabelas de origem cuja cópia do snapshot foi concluída. A conclusão significa que o snapshot de origem terminou de ler, não que todas as linhas migraram com sucesso; em caso de falha, uma tabela listada aqui também pode aparecer em failureError.

      • totalEventsSeen integer(int64)

        O valor padrão é 0.

      • snapshotConcluído booleano

        O valor padrão é false.

      • totalTableCount inteiro
      • totalEvents integer(int64)
      • totalEventSize integer(int64)
    • Estatísticas cdc objeto

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos cdcStatistics Mostrar atributos cdcStatistics objeto
      • startedAt string(data-hora)
      • lastEventTime string(data-hora)
      • lastEventSourceDatabaseTime string(data-hora)
      • eventosInLastHour integer(int64)

        O valor padrão é 0.

      • eventosNoLastMinute integer(int64)

        O valor padrão é 0.

      • totalEventsSeen integer(int64)

        O valor padrão é 0.

      • últimasBatchMaxSourceDbLagMs integer(int64)

        Para cada lote concluído de gravações no MongoDB, o atraso máximo de tempo desde quando uma alteração foi feita no banco de dados de origem (conforme relatado pelo banco de dados) até que a gravação em lote seja concluída. Isso pode ser afetado pelo desvio de relógio entre o relógio do banco de dados de origem e a máquina onde a migração está sendo executada.

        O valor padrão é -1.

    • jmxConnectivity objeto

      Conectividade da raspagem de estatísticas JMX (somente perfil de implantação kafka-connect). Indica se o migrador está raspando estatísticas com sucesso sobre JMX e quando o fez pela última vez, de modo que um ponto de extremidade JMX mal configurado/inacessível ou uma tarefa de conexão travada seja visível na IU. Ausente para implantações que não leem estatísticas sobre JMX.

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos jmxConnectivity Mostrar atributos jmxConnectivity objeto
      • Status string Obrigatório

        Os valores são AVAILABLE ou UNAVAILABLE.

      • lastSuccessfulScrapeAt string(data-hora)

        Hora da raspagem de estatísticas JMX mais recente bem-sucedida.

      • Mensagem de erro string

        O erro de conexão JMX mais recente, quando as estatísticas não estão disponíveis.

    • connectorStatus objeto

      Status de tempo de execução dos conectores Kafka Connect que dão suporte a esta tarefa de migração (somente perfis de implantação kafka-connect / confluent), refletindo o estado real relatado pelo Kafka Connect em vez de assumir o sucesso no momento do envio. Permite que a IU mostre qual conector/tarefa específico tem um problema em vez de uma tarefa que parece saudável enquanto um conector está FAILED. Ausente para implantações não suportadas pelo Kafka Connect.

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos connectorStatus Mostrar atributos connectorStatus objeto
      • Fonte objeto

        Status de tempo de execução de um conector Kafka Connect (origem ou coletor) e suas tarefas.

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos de origem Mostrar atributos de origem objeto
        • name string

          Nome do Connector conforme registrado no Kafka Connect.

        • state string Obrigatório

          Estado de tempo de execução relatado pelo Kafka Connect para um conector ou uma de suas tarefas (consulte https://kafka.apache.org/documentation/#connect_administration). UNKNOWN é o próprio valor do Relational Migrator para um status que não pôde ser recuperado, por exemplo, quando o trabalhador do Kafka Connect está inacessível.

          Os valores são RUNNING, PAUSED, FAILED, UNASSIGNED, RESTARTING, STOPPED ou UNKNOWN.

        • Tarefas array[objeto]

          Status de tempo de execução por tarefa para este conector.

          Ocultar atributos de tarefas Mostrar atributos de tarefa objeto

          Status de tempo de execução de uma única tarefa do Kafka Connect, conforme relatado pelo Kafka Connect.

          • id inteiro Obrigatório

            ID da tarefa dentro do conector.

          • state string Obrigatório

            Estado de tempo de execução relatado pelo Kafka Connect para um conector ou uma de suas tarefas (consulte https://kafka.apache.org/documentation/#connect_administration). UNKNOWN é o próprio valor do Relational Migrator para um status que não pôde ser recuperado, por exemplo, quando o trabalhador do Kafka Connect está inacessível.

            Os valores são RUNNING, PAUSED, FAILED, UNASSIGNED, RESTARTING, STOPPED ou UNKNOWN.

          • workerId string

            Trabalhador do Kafka Connect ao qual a tarefa é atribuída, quando conhecido.

          • RASTREAR string

            Rastreamento de pilha de falhas, presente quando o estado da tarefa é FAILED.

      • sink objeto

        Status de tempo de execução de um conector Kafka Connect (origem ou coletor) e suas tarefas.

        Propriedades adicionais NÃO são permitidas.

        Ocultar atributos do coletor Mostrar atributos do coletor objeto
        • name string

          Nome do Connector conforme registrado no Kafka Connect.

        • state string Obrigatório

          Estado de tempo de execução relatado pelo Kafka Connect para um conector ou uma de suas tarefas (consulte https://kafka.apache.org/documentation/#connect_administration). UNKNOWN é o próprio valor do Relational Migrator para um status que não pôde ser recuperado, por exemplo, quando o trabalhador do Kafka Connect está inacessível.

          Os valores são RUNNING, PAUSED, FAILED, UNASSIGNED, RESTARTING, STOPPED ou UNKNOWN.

        • Tarefas array[objeto]

          Status de tempo de execução por tarefa para este conector.

          Ocultar atributos de tarefas Mostrar atributos de tarefa objeto

          Status de tempo de execução de uma única tarefa do Kafka Connect, conforme relatado pelo Kafka Connect.

          • id inteiro Obrigatório

            ID da tarefa dentro do conector.

          • state string Obrigatório

            Estado de tempo de execução relatado pelo Kafka Connect para um conector ou uma de suas tarefas (consulte https://kafka.apache.org/documentation/#connect_administration). UNKNOWN é o próprio valor do Relational Migrator para um status que não pôde ser recuperado, por exemplo, quando o trabalhador do Kafka Connect está inacessível.

            Os valores são RUNNING, PAUSED, FAILED, UNASSIGNED, RESTARTING, STOPPED ou UNKNOWN.

          • workerId string

            Trabalhador do Kafka Connect ao qual a tarefa é atribuída, quando conhecido.

          • RASTREAR string

            Rastreamento de pilha de falhas, presente quando o estado da tarefa é FAILED.

    • failureError objeto

      Propriedades adicionais NÃO são permitidas.

      Ocultar atributos failureError Mostrar atributos failureError objeto
      • errorType string Obrigatório
      • mensagem string Obrigatório
      • failureAt string(data-hora) Obrigatório
      • erro de configuração booleano Obrigatório

        O valor padrão é false.

      • failedLocation corda | zero

        Localização do último erro antes que a tarefa falhasse. Consulte os logs da tarefa para obter o detalhamento completo do erro.

      • failedLocationType corda | zero

        TABLE = tabela de origem, COLLECTION = coleção de destino.

        Os valores são TABLE ou COLLECTION.

    • metadata objeto

      Propriedades adicionais NÃO são permitidas.

      Hide metadata attributes Mostrar atributos de metadados objeto
      • telemetryUserId string
      • verificação objeto
        Ocultar atributos de verificação Mostrar atributos de verificação objeto
        • samplePercentage inteiro

          O valor padrão é 100.

        • isEmbeddedMode booleano

          O valor padrão é false.

        • Status string

          Os valores são VERIFYING, FAILED, CANCELLING, CANCELLED, VERIFIED ou ABORTED.

    • relacionalTableFilters objeto

      Um objeto onde cada chave representa um nome de esquema. Cada esquema contém tabelas nas quais você pode aplicar filtros de tabela.

      Ocultar atributo relacionalTableFilters Mostrar atributo relacionalTableFilters objeto
      • * objeto Propriedades adicionais

        Um objeto onde cada chave representa um nome de tabela dentro de um esquema.

        Ocultar atributo * Mostrar atributo * objeto
        • * objeto Propriedades adicionais

          Propriedades adicionais NÃO são permitidas.

          Ocultar atributos * Mostrar atributos * objeto
          • ondeCláusula string

            Conteúdo da cláusula SQL ONDE para filtrar linhas da tabela de origem especificada.

          • rowCount integer(int64)

            Limite opcional para o número de linhas retornadas da tabela de origem.

            O valor mínimo é 1.

    • collectionFilters objeto

      Inclua ou exclua coleções para esta migração.

      • incluir somente: somente as collections que corresponderem ao filtro de inclusão especificado serão migradas.
      • somente excluir: todas as collections serão migradas, exceto aquelas que correspondem ao filtro de exclusão.
      • incluir e excluir: Migre collections que correspondam ao filtro de inclusão, excluindo aquelas que também correspondam ao filtro de exclusão.
      • Sem filtros: todas as collections serão migradas.
      Ocultar atributos collectionFilters Mostrar atributos collectionFilters objeto
      • Incluir array[string]
      • excluir array[string]
  • 500 aplicação/json

    Erro interno do servidor

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • errorType string Obrigatório

      Uma categoria de erro que identifica o tipo de erro ocorrido.

    • mensagem string Obrigatório

      Uma explicação legível do que deu errado.

    • timestamp string(data-hora) Obrigatório

      A data e a hora em que o erro ocorreu.

    • Problemas array[objeto]

      Os problemas individuais que compõem esse erro.

      Pelo menos 1 elemento.

      Ocultar atributos de problemas Mostrar atributos de problemas objeto
      • type string Obrigatório

        Uma categoria de erro que identifica o tipo de problema ocorrido (SNAKE_CASE).

      • mensagem string Obrigatório

        Uma explicação legível do que deu errado.

      • pointer string

        JSON Pointer (RFC 6901) para o nó ofensivo.

GET /jobs
curl \
 --request GET 'http://127.0.0.1:8278/api/v1/jobs'
Exemplos de resposta (200)
[
  {
    "id": "string",
    "projectId": "string",
    "status": "NOT_STARTED",
    "cdcStatus": "NOT_STARTED",
    "verificationJobId": "string",
    "options": {
      "dropCollections": false,
      "mode": "SNAPSHOT",
      "truncationReportMode": "FAIL",
      "errorHandling": "FAIL",
      "errorTolerance": 42,
      "incrementalSnapshotOptions": {
        "signalingTable": "database.schema.table",
        "chunkSize": 42
      }
    },
    "jdbcConnectionString": "string",
    "mongoDbConnectionString": "string",
    "submittedAt": "2026-05-04T09:42:00Z",
    "statistics": {
      "startedAt": "2026-05-04T09:42:00Z",
      "elapsedSeconds": 42,
      "remainingTableCount": 42,
      "processingTables": [
        "string"
      ],
      "migratedTables": [
        "string"
      ],
      "totalEventsSeen": 0,
      "snapshotCompleted": false,
      "totalTableCount": 42,
      "totalEvents": 42,
      "totalEventSize": 42
    },
    "cdcStatistics": {
      "startedAt": "2026-05-04T09:42:00Z",
      "lastEventTime": "2026-05-04T09:42:00Z",
      "lastEventSourceDatabaseTime": "2026-05-04T09:42:00Z",
      "eventsInLastHour": 0,
      "eventsInLastMinute": 0,
      "totalEventsSeen": 0,
      "latestBatchMaxSourceDbLagMs": -1
    },
    "jmxConnectivity": {
      "status": "AVAILABLE",
      "lastSuccessfulScrapeAt": "2026-05-04T09:42:00Z",
      "errorMessage": "string"
    },
    "connectorStatus": {
      "source": {
        "name": "string",
        "state": "RUNNING",
        "tasks": [
          {
            "id": 42,
            "state": "RUNNING",
            "workerId": "string",
            "trace": "string"
          }
        ]
      },
      "sink": {
        "name": "string",
        "state": "RUNNING",
        "tasks": [
          {
            "id": 42,
            "state": "RUNNING",
            "workerId": "string",
            "trace": "string"
          }
        ]
      }
    },
    "failureError": {
      "errorType": "string",
      "message": "string",
      "failureAt": "2026-05-04T09:42:00Z",
      "setupError": false,
      "failedLocation": "string",
      "failedLocationType": "TABLE"
    },
    "metadata": {
      "telemetryUserId": "string",
      "verification": {
        "samplePercentage": 100,
        "isEmbeddedMode": false,
        "status": "VERIFYING"
      }
    },
    "relationalTableFilters": {
      "schema_1_name": {
        "table_1_name": {
          "whereClause": "id > 1000 AND id <= 2000"
        },
        "table_2_name": {
          "whereClause": "TRUE",
          "rowCount": 10
        }
      }
    },
    "collectionFilters": {
      "include": [
        "string"
      ],
      "exclude": [
        "string"
      ]
    }
  }
]
Exemplos de resposta (500)
{
  "errorType": "VALIDATION_ERROR",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z",
  "issues": [
    {
      "type": "RELMIG_MAPPING_TABLE_MISSING",
      "message": "string",
      "pointer": "/project/content/mappings/0123456789abcdef0123456789abcdef/fields/Name/target/name"
    }
  ]
}