Crear una tarea de exportación de instantáneas

publicación /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports

Exporta una instantánea de copia de seguridad de un clúster Atlas dedicado mediante copias de seguridad en la nube a un contenedor de exportación. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de administrador de Project Atlas.

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})$.

  • Nombre del clúster string Requerido

    Etiqueta legible por humanos que identifica el clúster.

    El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

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

Información sobre la tarea de exportación de snapshot de Cloud Backup que se va a crear.

  • datos personalizados arreglo[objeto]

    Colección de pares clave-valor que representan datos personalizados para agregar al archivo de metadatos que MongoDB Cloud carga en el bucket cuando finaliza el trabajo de exportación.

    Ocultar atributos customData Mostrar atributos de datos personalizados Objeto

    Colección de pares clave-valor que representan datos personalizados para agregar al archivo de metadatos que MongoDB Cloud carga en el bucket cuando finaliza el trabajo de exportación.

    • llave string

      Clave para el archivo de metadatos que MongoDB Nube carga en el bucket cuando se completa la tarea de exportación.

    • Valor string

      Valor para la clave que se debe incluir en el archivo que MongoDB Cloud sube al bucket cuando finaliza la tarea de exportación.

  • exportBucketId string Requerido

    String única de caracteres hexadecimales 24que identifica el Export Bucket.

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

  • snapshotId string Requerido

    string única de 24caracteres hexadecimales que identifica la Snapshot de respaldo en la nube a exportar.

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

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • Componentes arreglo[objeto]

      Información sobre la tarea de exportación para cada set de réplicas en el clúster.

      Ocultar atributos de componentes Mostrar atributos de componentes Objeto
      • exportId string

        Cadena de caracteres hexadecimales 24única que identifica el trabajo de exportación de instantáneas de Cloud Backup para cada fragmento en un clúster fragmentado.

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

      • replicaSetName string

        Etiqueta legible por humanos que identifica el set de réplicas en el clúster.

    • creado a las string(date-time)

      Fecha y hora en que un usuario o Atlas creó la Tarea de Exportación. MongoDB nube representa esta marca temporal en formato ISO 8601 en UTC.

    • datos personalizados arreglo[objeto]

      Colección de pares clave-valor que representan datos personalizados para el archivo de metadatos que MongoDB Nube sube cuando la tarea de exportación finaliza.

      Ocultar atributos customData Mostrar atributos de datos personalizados Objeto

      Colección de pares clave-valor que representan datos personalizados para agregar al archivo de metadatos que MongoDB Cloud carga en el bucket cuando finaliza el trabajo de exportación.

      • llave string

        Clave para el archivo de metadatos que MongoDB Nube carga en el bucket cuando se completa la tarea de exportación.

      • Valor string

        Valor para la clave que se debe incluir en el archivo que MongoDB Cloud sube al bucket cuando finaliza la tarea de exportación.

    • exportBucketId string Requerido

      String única de caracteres hexadecimales 24que identifica el Export Bucket.

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

    • estado de exportación Objeto

      Estado de la tarea de exportación.

      Ocultar atributos exportStatus Mostrar los atributos exportStatus Objeto
      • Colecciones exportadas integer(int32)

        Cantidad de colecciones cuyos documentos se exportaron al Export Bucket.

      • coleccionesTotales integer(int32)

        Recuento total de colecciones cuyos documentos se exportarán al contenedor de exportación.

    • finalizó a las string(date-time)

      Fecha y hora en que se completó esta tarea de exportación. MongoDB nube representa esta marca de tiempo en formato ISO 8601 en UTC.

    • ID string

      string hexadecimal 24única que identifica la tarea de restauración.

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

    • prefix string

      Prefijo utilizado para todos los objetos de almacenamiento de blobs cargados como parte de la Tarea de Exportación.

      El formato debe coincidir con el siguiente patrón: /exported_snapshots/\{ORG-NAME\}/\{PROJECT-NAME\}/\{CLUSTER-NAME\}/\{SNAPSHOT-INITIATION-DATE\}/\{TIMESTAMP\}.

    • snapshotId string

      Cadena única de 24 caracteres hexadecimales que identifica la instantánea.

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

    • Estado string

      Estado de la tarea de exportación.

      Los valores son Cancelled, Failed, InProgress, Queued o Successful.

    • stateReason Objeto

      Indica el motivo de la tarea. Esto se establece cuando el estado de la tarea es "Error".

      Ocultar atributos de stateReason Show stateReason attributes Objeto
      • errorCode string

        Código de error relacionado con el estado.

      • mensaje string

        Mensaje que describe el error o estado.

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

POST /api/atlas/v1.0/grupos/{IDdegrupo}/clústeres/{nombredelclúster}/copiadeseguridad/exportaciones
curl \
 --request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/exports' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"customData":[{"key":"string","value":"string"}],"exportBucketId":"32b6e34b3d91647abb20e7b8","snapshotId":"32b6e34b3d91647abb20e7b8"}'
Solicitar ejemplos
{
  "customData": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "exportBucketId": "32b6e34b3d91647abb20e7b8",
  "snapshotId": "32b6e34b3d91647abb20e7b8"
}
Ejemplos de respuestas (200)
{
  "components": [
    {
      "exportId": "32b6e34b3d91647abb20e7b8",
      "replicaSetName": "string"
    }
  ],
  "createdAt": "2026-05-04T09:42:00Z",
  "customData": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "exportBucketId": "32b6e34b3d91647abb20e7b8",
  "exportStatus": {
    "exportedCollections": 42,
    "totalCollections": 42
  },
  "finishedAt": "2026-05-04T09:42:00Z",
  "id": "32b6e34b3d91647abb20e7b8",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "prefix": "string",
  "snapshotId": "32b6e34b3d91647abb20e7b8",
  "state": "Cancelled",
  "stateReason": {
    "errorCode": "string",
    "message": "string"
  }
}
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"
}