Postar uma nova tarefa de migração

POSTAR /jobs

aplicação/json

corpo, corpo Obrigatório

projectId string Obrigatório
jdbcConnectionDetails objeto Obrigatório

Propriedades adicionais NÃO são permitidas.
Ocultar atributos jdbcConnectionDetails Mostrar atributos jdbcConnectionDetails objeto
- id string
- type string Obrigatório
  
  Tipo de banco de dados ou tipo de banco de dados personalizado. Por exemplo, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ ou YUGABYTE.
- URL string Obrigatório
- utilizador string
- Senha string
- salvar senha booleano
  
  O valor padrão é false.
- existsConnectionId string
- oraclePdbName string
- isManualUri booleano
  
  O valor padrão é false.
mongodbConnectionDetails objeto Obrigatório

Propriedades adicionais NÃO são permitidas.
Ocultar atributos mongodbConnectionDetails Mostrar atributos mongodbConnectionDetails objeto
- id string
- ConnectionString string Obrigatório
- salvar senha booleano
  
  O valor padrão é false.
- existsConnectionId 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.
- 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.
verificação objeto Obrigatório

Propriedades adicionais NÃO são permitidas.
Ocultar atributos de verificação Mostrar atributos de verificação objeto
- habilitado booleano Obrigatório
  
  O valor padrão é false.
- collections incluídas array[string]
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.

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.
  
  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)
  
  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.
- 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.
440 aplicação/json

Inválido porque a string de conexão não contém um nome de banco de dados
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
470 aplicação/json

A tarefa de migração já está em execução
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
471 aplicação/json

A tarefa de migração não pôde ser iniciada devido a um erro ao construir o exemplo de contexto da tarefa - Modo não reconhecido ou Não existem mapeamentos.
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
500 aplicação/json

Erro interno do servidor
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

POST /jobs

curl \
 --request POST 'http://127.0.0.1:8278/api/v1/jobs' \
 --header "Content-Type: application/json" \
 --data '{"projectId":"string","jdbcConnectionDetails":{"id":"string","type":"ORACLE","url":"string","user":"string","password":"string","savePassword":false,"existingConnectionId":"string","oraclePdbName":"string","isManualUri":false},"mongodbConnectionDetails":{"id":"string","connectionString":"string","savePassword":false,"existingConnectionId":"string"},"options":{"dropCollections":false,"mode":"SNAPSHOT","errorHandling":"FAIL","errorTolerance":42},"verification":{"enabled":false,"includedCollections":["string"]},"relationalTableFilters":{"schema_1_name":{"table_1_name":{"whereClause":"id \u003e 1000 AND id \u003c= 2000"},"table_2_name":{"rowCount":10,"whereClause":"TRUE"}}}}'

Exemplos de solicitação

{
  "projectId": "string",
  "jdbcConnectionDetails": {
    "id": "string",
    "type": "ORACLE",
    "url": "string",
    "user": "string",
    "password": "string",
    "savePassword": false,
    "existingConnectionId": "string",
    "oraclePdbName": "string",
    "isManualUri": false
  },
  "mongodbConnectionDetails": {
    "id": "string",
    "connectionString": "string",
    "savePassword": false,
    "existingConnectionId": "string"
  },
  "options": {
    "dropCollections": false,
    "mode": "SNAPSHOT",
    "errorHandling": "FAIL",
    "errorTolerance": 42
  },
  "verification": {
    "enabled": false,
    "includedCollections": [
      "string"
    ]
  },
  "relationalTableFilters": {
    "schema_1_name": {
      "table_1_name": {
        "whereClause": "id > 1000 AND id <= 2000"
      },
      "table_2_name": {
        "rowCount": 10,
        "whereClause": "TRUE"
      }
    }
  }
}

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": "2026-05-04T09:42:00Z",
  "statistics": {
    "startedAt": "2026-05-04T09:42:00Z",
    "elapsedSeconds": 42,
    "remainingTableCount": 42,
    "processingTables": [
      "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
  },
  "failureError": {
    "errorType": "string",
    "message": "string",
    "failureAt": "2026-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 (440)

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}

Exemplos de resposta (470)

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}

Exemplos de resposta (471)

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}

Exemplos de resposta (500)

{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}