Crea un bucket de exportación de instantáneas para un bucket de AWS S3, un contenedor de almacenamiento de blobs de Azure o un bucket de almacenamiento de Google Cloud.
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.
Una vez creado, un snapshot se puede exportar al Export Bucket y a su Bucket de AWS S3 referenciado, Contenedor de Almacenamiento Azure Blob o Bucket de Google Cloud Storage. Para usar este recurso, la cuenta de servicio o clave de API que lo solicita debe tener el rol de propietario del proyecto.
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-creategroupbackupexportbucket.
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 cloudBackups createExportBucket [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--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. |
--file | string | false | ruta a tu archivo de solicitud de API. Déjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos. |
--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 createExportBucket | |
-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) |
--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 a utilizar al llamar a la llamada api [opciones: "2023-01-01", "2024-05-30"], por defecto se utilizará la última versión o el valor de configuración api_version de los perfiles si se establece. Este valor tiene como valor por defecto "2024-05-30". |
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
AWS
Cree el archivo siguiente y guárdelo como payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592", "requirePrivateNetworking": false }
Después de crear payload.json, ejecuta el siguiente comando en el mismo directorio.
atlas api cloudBackups createExportBucket --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
AWS
Cree el archivo siguiente y guárdelo como payload.json
{ "bucketName": "export-bucket", "cloudProvider": "AWS", "iamRoleId": "668c5f0ed436263134491592", "requirePrivateNetworking": false }
Después de crear payload.json, ejecuta el siguiente comando en el mismo directorio.
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
Azure
Cree el archivo siguiente y guárdelo como payload.json
{ "bucketName": "examplecontainer", "cloudProvider": "AZURE", "roleId": "668c5f0ed436263134491592", "serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer" }
Después de crear payload.json, ejecuta el siguiente comando en el mismo directorio.
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8
GCP
Cree el archivo siguiente y guárdelo como payload.json
{ "bucketName": "export-bucket", "cloudProvider": "GCP", "roleId": "668c5f0ed436263134491592" }
Después de crear payload.json, ejecuta el siguiente comando en el mismo directorio.
atlas api cloudBackups createExportBucket --version 2024-05-30 --groupId 32b6e34b3d91647abb20e7b8