Devuelve todos los trabajos de restauración de respaldos heredados para un clúster en el Proyecto especificado.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para utilizar este recurso, la cuenta de servicio o clave de API que lo solicita debe tener el rol de solo lectura del proyecto.
A partir del 23 de marzo de 2020, todos los nuevos clústeres solo pueden usar Copias de seguridad en la nube. Cuando actualizas a la versión 4.2, tu sistema de copia de seguridad se actualiza a copias de seguridad en la nube si actualmente está configurado como respaldos heredados. Após essa atualização, todos os seus snapshots de respaldos heredados existentes permanecem disponíveis. Eles expiram com o tempo, em conformidade com sua política de retenção. Su política de copia de seguridad se restablece al cronograma por defecto. Si tenías una política de respaldo personalizada con respaldos heredados, debes volver a crearla siguiendo el procedimiento descrito en la documentación de Cloud Backup. Si usas el parámetro query BATCH-ID, puedes recuperar todas las tareas de restauración en el lote especificado. Al crear un trabajo de restauración para un clúster particionado, MongoDB Cloud crea un trabajo separado para cada partición, más otro para el servidor de configuración. Cada una de esas tareas forma parte de un lote. Sin embargo, un lote no puede incluir un trabajo de restauración para un conjunto de réplicas.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-listgroupclusterrestorejobs.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api legacyBackup listClusterRestoreJobs [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--ID de lote | string | false | string única de 24 dígitos hexadecimales que identifica el agrupar de tareas de restauración que se devolverán. Marca de tiempo en formato de fecha y hora ISO 8601 en UTC al crear una tarea de restauración para un clúster particionado, la aplicación crea una tarea separada para cada partición, además de otra para el host de configuración. Cada una de estas tareas forman un lote. Una tarea de restauración para un set de réplicas no puede formar parte de un lote. |
--clusterName | string | true | Etiqueta legible por humanos que identifica el clúster con la snapshot que deseas devolver. |
--envelope | envelope | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
--groupId | string | true | Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/groups](#tag/Projects/operation/listProjects) 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. |
-h, --help | false | ayuda para listClusterRestoreJobs | |
--includeCount | false | Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta. | |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--outputFile | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api legacyBackup listClusterRestoreJobs --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8