Actualización de una canalización de Data Lake Obsoleto

PATCH /api/atlas/v1.0/groups/{groupId}/pipelines/{pipelineName}

Actualiza un lago de datos Pipeline.

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

  • nombreDeLaOleoducto string Requerido

    etiqueta legible por humanos que identifica la pipeline de lago de datos.

    El formato debe coincidir con el siguiente patrón: ^[^/\\ "$]{1,64}$.

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

aplicación/json

Cuerpo Requerido

Actualiza un lago de datos Pipeline.

  • Política de retención del conjunto de datos Objeto

    Política de retención de datasets para una pipeline programada de lago de datos.

    Ocultar atributos de datasetRetentionPolicy Mostrar atributos de datasetRetentionPolicy Objeto
    • unidades string Requerido

      Cantidad de tiempo en que Data Lake Pipeline mide la retención del conjunto de datos.

      Los valores son DAYS, WEEKS o MONTHS.

    • Valor integer(int32) Requerido

      Número que indica la cantidad de días, semanas o meses que el lago de datos pipeline conservará los conjuntos de datos.

      El valor mínimo es 1.

  • Nombre string

    Nombre de esta tubería de Data Lake.

  • disipador Objeto

    Atlas Data Lake almacenamiento como destino de una pipeline de lago de datos.

    Ocultar atributos de sumidero Mostrar atributos del fregadero Objeto
    • metadataProvider string

      Proveedor de nube objetivo para esta lago de datos pipeline.

      El valor es AWS.

    • metadataRegion string

      Región del proveedor de nube de destino para esta canalización de Data Lake.

      Regiones de proveedores de nube compatibles
    • campos de partición arreglo[objeto]

      Campos ordenados que se utilizan para organizar físicamente los datos en el destino.

      Ocultar atributos de partitionFields Mostrar atributos de partitionFields Objeto

      Campo de partición en el proveedor de almacenamiento de lago de datos para un pipeline de lago de datos.

      • Nombre de campo string Requerido

        Etiqueta legible por humanos que identifica el nombre del campo utilizado para particionar los datos.

        La longitud máxima es 700.

      • orden integer(int32) Requerido

        Secuencia en la que MongoDB Cloud segmenta los datos de la colección para crear particiones. El recurso expresa esta secuencia comenzando desde cero.

        El valor por defecto es 0.

    • tipo Discriminador

      El valor es DLS.

  • Origen Objeto

    Uno de:
  • transformaciones arreglo[objeto]

    Campos que se excluirán para esta pipeline de lago de datos.

    Ocultar atributos de transformaciones Mostrar atributos de transformaciones Objeto

    Transformaciones de campo durante la ingesta de una tubería de Data Lake.

    • Campo string

      Teclea en el documento.

    • tipo string

      Tipo de transformación aplicada durante la exportación del namespace en un lago de datos Pipeline.

      El valor es EXCLUDE.

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • _id string

      string única de dígitos hexadecimales 24que identifica el lago de datos pipeline.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • createdDate string(date-time)

      Marca de tiempo que indica cuándo se creó el pipeline de lago de datos. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • Política de retención del conjunto de datos Objeto

      Política de retención de datasets para una pipeline programada de lago de datos.

      Ocultar atributos de datasetRetentionPolicy Mostrar atributos de datasetRetentionPolicy Objeto
      • lastModifiedDate string(date-time)

        Fecha en que se modificó por última vez la política de retención. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

      • unidades string Requerido

        Cantidad de tiempo en que Data Lake Pipeline mide la retención del conjunto de datos.

        Los valores son DAYS, WEEKS o MONTHS.

      • Valor integer(int32) Requerido

        Número que indica la cantidad de días, semanas o meses que el lago de datos pipeline conservará los conjuntos de datos.

        El valor mínimo es 1.

    • ID del grupo string

      Cadena única de dígitos 24-hexadecimal que identifica al grupo.

      El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

    • lastUpdatedDate string(date-time)

      Marca de tiempo que indica la última vez que se actualizó el lago de datos Pipeline. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

    • Nombre string

      Nombre de esta tubería de Data Lake.

    • disipador Objeto

      Atlas Data Lake almacenamiento como destino de una pipeline de lago de datos.

      Ocultar atributos de sumidero Mostrar atributos del fregadero Objeto
      • tipo string Discriminador

        Tipo de destino de ingestión de este pipeline de lago de datos.

        El valor es DLS.

      • metadataProvider string

        Proveedor de nube objetivo para esta lago de datos pipeline.

        El valor es AWS.

      • metadataRegion string

        Región del proveedor de nube de destino para esta canalización de Data Lake.

        Regiones de proveedores de nube compatibles
      • campos de partición arreglo[objeto]

        Campos ordenados que se utilizan para organizar físicamente los datos en el destino.

        Ocultar atributos de partitionFields Mostrar atributos de partitionFields Objeto

        Campo de partición en el proveedor de almacenamiento de lago de datos para un pipeline de lago de datos.

        • Nombre de campo string Requerido

          Etiqueta legible por humanos que identifica el nombre del campo utilizado para particionar los datos.

          La longitud máxima es 700.

        • orden integer(int32) Requerido

          Secuencia en la que MongoDB Cloud segmenta los datos de la colección para crear particiones. El recurso expresa esta secuencia comenzando desde cero.

          El valor por defecto es 0.

    • Origen Objeto

      Uno de:
    • Estado string

      Estado de esta pipeline de lago de datos.

      Los valores son ACTIVE o PAUSED.

    • transformaciones arreglo[objeto]

      Campos que se excluirán para esta pipeline de lago de datos.

      Ocultar atributos de transformaciones Mostrar atributos de transformaciones Objeto

      Transformaciones de campo durante la ingesta de una tubería de Data Lake.

      • Campo string

        Teclea en el documento.

      • tipo string

        Tipo de transformación aplicada durante la exportación del namespace en un lago de datos Pipeline.

        El valor es EXCLUDE.

  • 400 aplicación/json

    Solicitud incorrecta.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 409 aplicación/json

    Conflicto.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 500 aplicación/json

    Error interno del servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecta.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos arreglo[objeto]

        Describe todas las infracciones en una solicitud de cliente.

        Ocultar campos atributos Mostrar los atributos de los campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de la solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros arreglo[objeto]

      Parámetros utilizados para proporcionar más información sobre el error.

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

PARCHE /api/atlas/v1.0/grupos/{ID de grupo}/tuberías/{nombre de la tubería}
curl \
 --request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/pipelines/{pipelineName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"datasetRetentionPolicy":{"units":"DAYS","value":42},"name":"string","sink":{"metadataProvider":"AWS","metadataRegion":"string","partitionFields":[{"fieldName":"string","order":0}],"type":"DLS"},"source":{"type":"ON_DEMAND_CPS","clusterName":"string","collectionName":"string","databaseName":"string"},"transformations":[{"field":"string","type":"EXCLUDE"}]}'
Solicitar ejemplos
{
  "datasetRetentionPolicy": {
    "units": "DAYS",
    "value": 42
  },
  "name": "string",
  "sink": {
    "metadataProvider": "AWS",
    "metadataRegion": "string",
    "partitionFields": [
      {
        "fieldName": "string",
        "order": 0
      }
    ],
    "type": "DLS"
  },
  "source": {
    "type": "ON_DEMAND_CPS",
    "clusterName": "string",
    "collectionName": "string",
    "databaseName": "string"
  },
  "transformations": [
    {
      "field": "string",
      "type": "EXCLUDE"
    }
  ]
}
Ejemplos de respuestas (200)
{
  "_id": "32b6e34b3d91647abb20e7b8",
  "createdDate": "2026-05-04T09:42:00Z",
  "datasetRetentionPolicy": {
    "lastModifiedDate": "2026-05-04T09:42:00Z",
    "units": "DAYS",
    "value": 42
  },
  "groupId": "32b6e34b3d91647abb20e7b8",
  "lastUpdatedDate": "2026-05-04T09:42:00Z",
  "name": "string",
  "sink": {
    "type": "DLS",
    "metadataProvider": "AWS",
    "metadataRegion": "string",
    "partitionFields": [
      {
        "fieldName": "string",
        "order": 0
      }
    ]
  },
  "source": {
    "type": "ON_DEMAND_CPS",
    "clusterName": "string",
    "collectionName": "string",
    "databaseName": "string",
    "groupId": "32b6e34b3d91647abb20e7b8"
  },
  "state": "ACTIVE",
  "transformations": [
    {
      "field": "string",
      "type": "EXCLUDE"
    }
  ]
}
Ejemplos de respuestas (400)
{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (409)
{
  "error": 409,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
  "reason": "Conflict",
  "errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}