Devolver todas las tareas de exportación de snapshot

OBTENER /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/backup/exports

Devuelve todos los trabajos de exportación de instantáneas de copia de seguridad en la nube asociados con el clúster de Atlas especificado.

Requisitos del rol
  • Administrador de copia de seguridad del proyecto

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.

  • bonito booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

    El valor por defecto es false.

    pretty-print
  • includeCount booleano

    Indicador que señala si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor por defecto es true.

  • elementosPorPágina entero

    Número de elementos que la respuesta retorna por página.

    El valor mínimo es 1, el valor máximo es 500. El valor por defecto es 100.

  • Num. de pág. entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

Respuestas

  • 200 application/json

    OK

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

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar los atributos de resultados Mostrar los atributos de los resultados 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 los atributos de los componentes Objeto
        • exportId string

          string hexadecimal única de 24que identifica la tarea de exportación de instantáneas de Cloud Backup para cada partición 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 customData Objeto

        Colección de pares clave-valor que representan datos personalizados para agregar al archivo de metadatos que MongoDB Cloud sube al bucket cuando finaliza la tarea 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})$.

      • exportStatus 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)

          Conteo total de colecciones cuyos documentos se exportarán a la Cubeta 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

        String hexadecimal única de 24 caracteres que identifica el snapshot.

        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 el estado.

    • totalCount integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount está configurado en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 401 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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.

GET /api/atlas/v1.0/groups/{groupId}/clústeres/{clusterName}/copia de seguridad/exports
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/exports' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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"
      }
    }
  ],
  "totalCount": 42
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}