Publicar una nueva tarea de migración

publicación /tarea

application/json

Cuerpo Requerido

ID del proyecto string Requerido
jdbcConnectionDetails Objeto Requerido

NO se permiten propiedades adicionales.
Ocultar los atributos de jdbcConnectionDetails Mostrar atributos jdbcConnectionDetails Objeto
- ID string
- tipo string Requerido
  
  Tipo de base de datos o un tipo de base de datos personalizado. Por ejemplo, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, COCKROACHDB, DB2, SQLANYWHERE, SYBASE, SYBASEIQ o YUGABYTE.
- URL string Requerido
- usuario string
- Contraseña string
- savePassword booleano
  
  El valor por defecto es false.
- existingConnectionId string
- oraclePdbName string
- isManualUri booleano
  
  El valor por defecto es false.
mongodbConnectionDetails Objeto Requerido

NO se permiten propiedades adicionales.
Ocultar los atributos de mongodbConnectionDetails Mostrar atributos de mongodbConnectionDetails Objeto
- ID string
- Cadena de conexión string Requerido
- savePassword booleano
  
  El valor por defecto es false.
- existingConnectionId string
opciones Objeto Requerido

NO se permiten propiedades adicionales.
Ocultar atributos de opciones Mostrar atributos de opciones Objeto
- Descartar colecciones booleano
  
  El valor por defecto es false.
- moda string Requerido
  
  Los valores son SNAPSHOT, CDC, INCREMENTAL o VERIFICATION.
- truncationReportMode string
  
  Los valores son FAIL, WARN o SKIP.
- errorHandling string
  
  define si los errores de Debezium lanzarán una excepción o solo se registrarán. https://debezium.io/documentation/reference/stable/connectors/mysql.html#mysql-property-event-processing-failure-handling-mode
  
  Los valores son FAIL, WARN o SKIP.
- Tolerancia de error entero
  
  El número de fallas (a nivel de registro) que se deben tolerar antes de finalizar la migración. El valor es estrictamente mayor o igual que.
  
  El valor mínimo es 0.
- tabla de señalización string
verificación Objeto Requerido

NO se permiten propiedades adicionales.
Ocultar atributos de verificación Mostrar atributos de verificación Objeto
- habilitado booleano Requerido
  
  El valor por defecto es false.
- includedCollections array[string]
- Porcentaje de muestra entero
  
  El valor mínimo es 1, el valor máximo es 100. El valor por defecto es 100.
relationalTableFilters Objeto

Un objeto donde cada clave representa un nombre de esquema. Cada esquema contiene tablas en las que puedes aplicar filtros de tabla.
Ocultar atributo relationalTableFilters Mostrar atributo relationalTableFilters Objeto
- * Objeto Propiedades adicionales
  
  Un objeto donde cada clave representa un nombre de tabla dentro de un esquema.
  Hide * attribute Mostrar * atributo Objeto
  
  * Objeto Propiedades adicionales
  
  NO se permiten propiedades adicionales.
  
  Ocultar * atributos Mostrar * atributos Objeto
  
  whereClause string
  
  Contenido de la cláusula WHERE de SQL para filtrar filas de la tabla de origen especificada.
  
  rowCount integer(int64)
  
  Límite opcional para el número de filas devueltas desde la tabla fuente.
collectionFilters Objeto
Incluye o excluye colecciones para esta migración.
- solo incluir: Solo las colecciones que coincidan con el filtro de inclusión especificado serán migradas.
- excluir únicamente: todos los conjuntos de colecciones se migrarán, salvo aquellos que cumplan con el filtro de exclusión.
- incluir y excluir: migrar las colecciones que coincidan con el filtro de inclusión y excluir las que también coincidan con el filtro de exclusión.
- Sin filtros: Se migrarán todas las colecciones.
Ocultar atributos de collectionFilters Mostrar atributos de collectionFilters Objeto
- Incluir array[string]
- excluir array[string]

Respuestas

200 application/json

OK
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- ID string Requerido
  
  El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.
- ID del proyecto string Requerido
  
  El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.
- Estado string Requerido
  
  Los valores son NOT_STARTED, RUNNING, FAILED, CANCELLING, CANCELLED, COMPLETED, CLEANING_UP o PAUSED.
- cdcStatus string
  
  Los valores son NOT_STARTED, RUNNING, COMPLETING, COMPLETED, FAILED, CANCELLED o PAUSED. El valor por defecto es NOT_STARTED.
- verificationJobId string
- opciones Objeto Requerido
  
  NO se permiten propiedades adicionales.
  
  Ocultar atributos de opciones Mostrar atributos de opciones Objeto
  
  Descartar colecciones booleano
  
  El valor por defecto es false.
  
  moda string Requerido
  
  Los valores son SNAPSHOT, CDC, INCREMENTAL o VERIFICATION.
  
  truncationReportMode string
  
  Los valores son FAIL, WARN o SKIP.
  
  errorHandling string
  
  define si los errores de Debezium lanzarán una excepción o solo se registrarán. https://debezium.io/documentation/reference/stable/connectors/mysql.html#mysql-property-event-processing-failure-handling-mode
  
  Los valores son FAIL, WARN o SKIP.
  
  Tolerancia de error entero
  
  El número de fallas (a nivel de registro) que se deben tolerar antes de finalizar la migración. El valor es estrictamente mayor o igual que.
  
  El valor mínimo es 0.
  
  tabla de señalización string
- jdbcConnectionString string
- mongoDbConnectionString string
- submittedAt string(date-time) Requerido
- estadísticas Objeto
  
  NO se permiten propiedades adicionales.
  
  Ocultar atributos de estadísticas Mostrar atributos estadísticos Objeto
  
  startedAt string(date-time)
  
  elapsedSeconds integer(int64)
  
  remainingTableCount entero
  
  processingTables array[string]
  
  totalEventsSeen integer(int64)
  
  El valor por defecto es 0.
  
  snapshotCompleted booleano
  
  El valor por defecto es false.
  
  totalTableCount entero
  
  totalEvents integer(int64)
  
  totalEventSize integer(int64)
- cdcStatistics Objeto
  
  NO se permiten propiedades adicionales.
  
  Oculta los atributos de cdcStatistics Mostrar atributos de cdcStatistics Objeto
  
  startedAt string(date-time)
  
  lastEventTime string(date-time)
  
  lastEventSourceDatabaseTime string(date-time)
  
  eventosEnLaUltimaHora integer(int64)
  
  El valor por defecto es 0.
  
  eventosEnElÚltimoMinuto integer(int64)
  
  El valor por defecto es 0.
  
  totalEventsSeen integer(int64)
  
  El valor por defecto es 0.
  
  latestBatchMaxSourceDbLagMs integer(int64)
  
  Para cada grupo completado de guardados en MongoDB, el tiempo máximo de demora desde que se realizó un cambio en la base de datos origen (según lo informado por la base de datos) hasta que se completó el guardado del grupo. Esto podría verse afectado por la desviación del reloj entre el reloj de la base de datos de origen y la máquina donde se ejecuta la migración.
  
  El valor por defecto es -1.
- failureError Objeto
  
  NO se permiten propiedades adicionales.
  
  Ocultar los atributos de failureError Mostrar los atributos failureError Objeto
  
  tipoDeError string Requerido
  
  mensaje string Requerido
  
  fallo en string(date-time) Requerido
  
  error de configuración booleano Requerido
  
  El valor por defecto es false.
- metadata Objeto
  
  NO se permiten propiedades adicionales.
  
  Hide metadata attributes Mostrar los atributos de metadatos Objeto
  
  telemetryUserId string
  
  verificación Objeto
  
  Ocultar atributos de verificación Mostrar atributos de verificación Objeto
  
  Porcentaje de muestra entero
  
  El valor por defecto es 100.
  
  isEmbeddedMode booleano
  
  El valor por defecto es false.
  
  Estado string
  
  Los valores son VERIFYING, FAILED, CANCELLING, CANCELLED, VERIFIED o ABORTED.
- relationalTableFilters Objeto
  
  Un objeto donde cada clave representa un nombre de esquema. Cada esquema contiene tablas en las que puedes aplicar filtros de tabla.
  
  Ocultar atributo relationalTableFilters Mostrar atributo relationalTableFilters Objeto
  
  * Objeto Propiedades adicionales
  
  Un objeto donde cada clave representa un nombre de tabla dentro de un esquema.
  
  Hide * attribute Mostrar * atributo Objeto
  
  * Objeto Propiedades adicionales
  
  NO se permiten propiedades adicionales.
  
  Ocultar * atributos Mostrar * atributos Objeto
  
  whereClause string
  
  Contenido de la cláusula WHERE de SQL para filtrar filas de la tabla de origen especificada.
  
  rowCount integer(int64)
  
  Límite opcional para el número de filas devueltas desde la tabla fuente.
- collectionFilters Objeto
  
  Incluye o excluye colecciones para esta migración.
  
  solo incluir: Solo las colecciones que coincidan con el filtro de inclusión especificado serán migradas.
  
  excluir únicamente: todos los conjuntos de colecciones se migrarán, salvo aquellos que cumplan con el filtro de exclusión.
  
  incluir y excluir: migrar las colecciones que coincidan con el filtro de inclusión y excluir las que también coincidan con el filtro de exclusión.
  
  Sin filtros: Se migrarán todas las colecciones.
  
  Ocultar atributos de collectionFilters Mostrar atributos de collectionFilters Objeto
  
  Incluir array[string]
  
  excluir array[string]
470 application/json

Tarea de migración ya en curso
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- jobId string
  
  El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.
- mensaje string Requerido
- Descripción string
- Marca de tiempo string(date-time) Requerido
471 application/json

No se pudo iniciar la tarea de migración debido a un error al construir el ejemplo de contexto de la tarea: modo no reconocido o no existen asignaciones.
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- jobId string
  
  El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.
- mensaje string Requerido
- Descripción string
- Marca de tiempo string(date-time) Requerido
500 application/json

Error interno del servidor
Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
- jobId string
  
  El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.
- mensaje string Requerido
- Descripción string
- Marca de tiempo string(date-time) Requerido

POST /tareas

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","truncationReportMode":"FAIL","errorHandling":"FAIL","errorTolerance":42,"signalingTable":"database.schema.table"},"verification":{"enabled":false,"includedCollections":["string"],"samplePercentage":100},"relationalTableFilters":{"schema_1_name":{"table_1_name":{"whereClause":"id \u003e 1000 AND id \u003c= 2000"},"table_2_name":{"whereClause":"TRUE","rowCount":10}}},"collectionFilters":{"include":["string"],"exclude":["string"]}}'

Solicitar ejemplos

{
  "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",
    "truncationReportMode": "FAIL",
    "errorHandling": "FAIL",
    "errorTolerance": 42,
    "signalingTable": "database.schema.table"
  },
  "verification": {
    "enabled": false,
    "includedCollections": [
      "string"
    ],
    "samplePercentage": 100
  },
  "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"
    ]
  }
}

Ejemplos de respuesta (200)

{
  "id": "string",
  "projectId": "string",
  "status": "NOT_STARTED",
  "cdcStatus": "NOT_STARTED",
  "verificationJobId": "string",
  "options": {
    "dropCollections": false,
    "mode": "SNAPSHOT",
    "truncationReportMode": "FAIL",
    "errorHandling": "FAIL",
    "errorTolerance": 42,
    "signalingTable": "database.schema.table"
  },
  "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",
    "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"
    ]
  }
}

Ejemplos de respuesta (470)

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

Ejemplos de respuesta (471)

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

Ejemplos de respuesta (500)

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