Publicar un nuevo trabajo de migración

PUBLICAR /trabajos

Publicar un nuevo trabajo de migración

aplicación/json

Cuerpo Requerido

  • ID del proyecto string Requerido
  • Detalles de conexión jdbc 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
    • guardar contraseña booleano

      El valor predeterminado es false.

    • Id. de conexión existente string
    • NombrePdbOracle string
    • isManualUri booleano

      El valor predeterminado es false.

  • Detalles de conexión de mongodb Objeto Requerido

    NO se permiten propiedades adicionales.

    Ocultar atributos de mongodbConnectionDetails Mostrar atributos de mongodbConnectionDetails Objeto
    • ID. string
    • cadena de conexión string Requerido
    • guardar contraseña booleano

      El valor predeterminado es false.

    • Id. de conexión existente string
  • opciones Objeto Requerido

    NO se permiten propiedades adicionales.

    Ocultar atributos de opciones Mostrar atributos de opciones Objeto
    • Colecciones de caída booleano

      El valor predeterminado es false.

    • moda string Requerido

      Los valores son SNAPSHOT, CDC o INCREMENTAL.

    • errorHandling string

      Los valores son FAIL, WARN o SKIP. El valor predeterminado es FAIL.

    • tolerancia de error entero

      El número de fallos (a nivel de registro) que se deben tolerar antes de finalizar la migración. El valor es estrictamente mayor o igual a.

      El valor mínimo es 0.

  • verificación Objeto Requerido

    NO se permiten propiedades adicionales.

    Ocultar atributo de verificación Mostrar atributo de verificación Objeto
    • habilitado booleano Requerido

      El valor predeterminado es false.

  • filtros de tabla relacionales Objeto

    Un objeto donde cada clave representa un nombre de esquema. Cada esquema contiene tablas a las que se pueden aplicar filtros.

    Ocultar el atributo relationalTableFilters Mostrar el atributo relationalTableFilters Objeto
    • * Objeto Propiedades adicionales

      Un objeto donde cada clave representa un nombre de tabla dentro de un esquema.

      Ocultar * atributo Mostrar atributo * Objeto
      • * Objeto Propiedades adicionales

        NO se permiten propiedades adicionales.

        Ocultar * atributos Mostrar * atributos Objeto
        • cláusula where string

          Contenido de la cláusula WHERE de SQL para filtrar filas de la tabla de origen especificada.

        • recuento de filas integer(int64)

          Límite opcional para la cantidad de filas devueltas desde la tabla de origen.

  • filtros de colección Objeto

    Incluir o excluir colecciones para esta migración.

    • solo incluir: solo se migrarán las colecciones que coincidan con el filtro de inclusión especificado.
    • Solo excluir: se migrarán todas las colecciones, excepto aquellas que coincidan con el filtro de exclusión.
    • Incluir y excluir: migrar colecciones que coincidan con el filtro de inclusión, excluyendo aquellas 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
    • incluyen array[string]
    • excluir array[string]

Respuestas

  • 200 aplicación/json

    Vale

    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 predeterminado es NOT_STARTED.

    • VerificaciónJobId string
    • opciones Objeto Requerido

      NO se permiten propiedades adicionales.

      Ocultar atributos de opciones Mostrar atributos de opciones Objeto
      • Colecciones de caída booleano

        El valor predeterminado es false.

      • moda string Requerido

        Los valores son SNAPSHOT, CDC o INCREMENTAL.

      • errorHandling string

        Los valores son FAIL, WARN o SKIP. El valor predeterminado es FAIL.

      • tolerancia de error entero

        El número de fallos (a nivel de registro) que se deben tolerar antes de finalizar la migración. El valor es estrictamente mayor o igual a.

        El valor mínimo es 0.

    • jdbcConnectionString string
    • Cadena de conexión de mongoDb string
    • submittedAt cadena(fecha-hora) Requerido
    • estadísticas Objeto

      NO se permiten propiedades adicionales.

      Ocultar atributos de estadísticas Mostrar atributos de estadísticas Objeto
      • startedAt cadena(fecha-hora)
      • segundos transcurridos integer(int64)
      • recuento de tablas restantes entero
      • processingTables array[string]
      • totalEventsSeen integer(int64)

        El valor predeterminado es 0.

      • instantáneaCompletada booleano

        El valor predeterminado es false.

      • recuentototaldetablas entero
      • totalEventos integer(int64)
      • totalEventSize integer(int64)
    • Estadísticas de los CDC Objeto

      NO se permiten propiedades adicionales.

      Ocultar atributos de cdcStatistics Mostrar atributos de cdcStatistics Objeto
      • startedAt cadena(fecha-hora)
      • lastEventTime cadena(fecha-hora)
      • eventosEnÚltimaHora integer(int64)

        El valor predeterminado es 0.

      • eventosEnÚltimoMinuto integer(int64)

        El valor predeterminado es 0.

      • totalEventsSeen integer(int64)

        El valor predeterminado es 0.

      • últimoLoteMaxSourceDbLagMs integer(int64)

        Para cada lote de escrituras completado en MongoDB, el tiempo máximo transcurrido desde que se realizó un cambio en la base de datos de origen (según lo informado por esta) hasta que se completó la escritura. Esto puede verse afectado por la diferencia de reloj entre el reloj de la base de datos de origen y el del equipo donde se ejecuta la migración.

        El valor predeterminado es -1.

    • Error de fallo Objeto

      NO se permiten propiedades adicionales.

      Ocultar atributos de error de fallo Mostrar atributos de error de falla Objeto
      • tipo de error string Requerido
      • Mensaje string Requerido
      • fracasoEn cadena(fecha-hora) Requerido
      • Error de configuración booleano Requerido

        El valor predeterminado es false.

    • metadata Objeto

      NO se permiten propiedades adicionales.

      Hide metadata attributes Mostrar atributos de metadatos Objeto
      • telemetryUserId string
      • Verificación solicitada booleano

        El valor predeterminado es false.

      • estado de verificación string

        Los valores son VERIFYING, FAILED, CANCELLING, CANCELLED, VERIFIED o ABORTED.

    • filtros de tabla relacionales Objeto

      Un objeto donde cada clave representa un nombre de esquema. Cada esquema contiene tablas a las que se pueden aplicar filtros.

      Ocultar el atributo relationalTableFilters Mostrar el atributo relationalTableFilters Objeto
      • * Objeto Propiedades adicionales

        Un objeto donde cada clave representa un nombre de tabla dentro de un esquema.

        Ocultar * atributo Mostrar atributo * Objeto
        • * Objeto Propiedades adicionales

          NO se permiten propiedades adicionales.

          Ocultar * atributos Mostrar * atributos Objeto
          • cláusula where string

            Contenido de la cláusula WHERE de SQL para filtrar filas de la tabla de origen especificada.

          • recuento de filas integer(int64)

            Límite opcional para la cantidad de filas devueltas desde la tabla de origen.

  • 440 aplicación/json

    No válido porque la cadena de conexión no contenía un nombre de base de datos

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID de trabajo string

      El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.

    • Mensaje string Requerido
    • Descripción string
    • fecha y hora cadena(fecha-hora) Requerido
  • 470 aplicación/json

    El trabajo de migración ya se está ejecutando

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID de trabajo string

      El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.

    • Mensaje string Requerido
    • Descripción string
    • fecha y hora cadena(fecha-hora) Requerido
  • 471 aplicación/json

    No se pudo iniciar el trabajo de migración debido a un error al crear el contexto del trabajo, por ejemplo: modo no reconocido o no existen asignaciones.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID de trabajo string

      El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.

    • Mensaje string Requerido
    • Descripción string
    • fecha y hora cadena(fecha-hora) Requerido
  • 500 aplicación/json

    Error Interno del Servidor

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • ID de trabajo string

      El formato debe coincidir con el siguiente patrón: ^[A-Za-z0-9\-]+$.

    • Mensaje string Requerido
    • Descripción string
    • fecha y hora cadena(fecha-hora) Requerido
PUBLICACIÓN /trabajos
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},"relationalTableFilters":{"schema_1_name":{"table_1_name":{"whereClause":"id \u003e 1000 AND id \u003c= 2000"},"table_2_name":{"rowCount":10,"whereClause":"TRUE"}}},"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",
    "errorHandling": "FAIL",
    "errorTolerance": 42
  },
  "verification": {
    "enabled": false
  },
  "relationalTableFilters": {
    "schema_1_name": {
      "table_1_name": {
        "whereClause": "id > 1000 AND id <= 2000"
      },
      "table_2_name": {
        "rowCount": 10,
        "whereClause": "TRUE"
      }
    }
  },
  "collectionFilters": {
    "include": [
      "string"
    ],
    "exclude": [
      "string"
    ]
  }
}
Ejemplos de respuestas (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",
    "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"
      }
    }
  }
}
Ejemplos de respuestas (440)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Ejemplos de respuestas (470)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Ejemplos de respuestas (471)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Ejemplos de respuestas (500)
{
  "jobId": "string",
  "message": "string",
  "description": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}