Obtenha o status de um tarefa de migração por ID

OBTER /jobs/{jobId}

Obtenha o status de um tarefa de migração por ID

parâmetros de caminho

  • jobId string Obrigatório

    jobId

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

    • 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 ou INCREMENTAL.

      • errorHandling string

        Os valores são FAIL, WARN ou SKIP. O valor padrão é FAIL.

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

    • 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]
      • 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)
      • eventosInLastHour integer(int64)

        O valor padrão é 0.

      • eventosNoLastMinute integer(int64)

        O valor padrão é 0.

      • totalEventsSeen integer(int64)

        O valor padrão é 0.

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

    • metadata objeto

      Propriedades adicionais NÃO são permitidas.

      Hide metadata attributes Mostrar atributos de metadados objeto
      • telemetryUserId string
      • verifyRequested booleano

        O valor padrão é false.

      • status de verificação 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.

  • 404 aplicação/json

    Não encontrado

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • jobId string

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

    • mensagem string Obrigatório
    • Descrição string
    • timestamp string(data-hora) Obrigatório
GET /jobs/{jobId}
curl \
 --request GET 'http://127.0.0.1:8278/api/v1/jobs/{jobId}'
Exemplos de resposta (200)
{
  "id": "string",
  "projectId": "string",
  "status": "NOT_STARTED",
  "cdcStatus": "NOT_STARTED",
  "verificationJobId": "string",
  "options": {
    "dropCollections": false,
    "mode": "SNAPSHOT",
    "errorHandling": "FAIL",
    "errorTolerance": 42
  },
  "jdbcConnectionString": "string",
  "mongoDbConnectionString": "string",
  "submittedAt": "2025-05-04T09:42:00Z",
  "statistics": {
    "startedAt": "2025-05-04T09:42:00Z",
    "elapsedSeconds": 42,
    "remainingTableCount": 42,
    "processingTables": [
      "string"
    ],
    "totalEventsSeen": 0,
    "snapshotCompleted": false,
    "totalTableCount": 42,
    "totalEvents": 42,
    "totalEventSize": 42
  },
  "cdcStatistics": {
    "startedAt": "2025-05-04T09:42:00Z",
    "lastEventTime": "2025-05-04T09:42:00Z",
    "eventsInLastHour": 0,
    "eventsInLastMinute": 0,
    "totalEventsSeen": 0
  },
  "failureError": {
    "errorType": "string",
    "message": "string",
    "failureAt": "2025-05-04T09:42:00Z",
    "setupError": false
  },
  "metadata": {
    "telemetryUserId": "string",
    "verificationRequested": false,
    "verificationStatus": "VERIFYING"
  },
  "relationalTableFilters": {
    "schema_1_name": {
      "table_1_name": {
        "whereClause": "id > 1000 AND id <= 2000"
      },
      "table_2_name": {
        "rowCount": 10,
        "whereClause": "TRUE"
      }
    }
  }
}
Exemplos de resposta (404)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2025-05-04T09:42:00Z"
}