Actualiza la configuración de la política de cumplimiento de copias de seguridad para el proyecto especificado.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Para utilizar este recurso, la cuenta de servicio solicitante o la clave API deben 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/operación/operación-updategroupbackupcompliancepolicy.
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 updateCompliancePolicy [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--envelope | envelope | false | Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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 | string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/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 updateCompliancePolicy | |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto 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) |
--overwriteBackupPolicies | false | Indicador que indica si se deben sobrescribir las políticas de copia de seguridad que no cumplen con las nuevas configuraciones de protección de datos o no. | |
--bastante | 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", "2023-10-01"], 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 "2023-10-01". |
-w, --watch | false | Indicador que señala si se debe observar el comando hasta que complete su ejecución o hasta que se agote el tiempo de observación. | |
--watchTimeout | Int | false | Tiempo en segundos hasta que una conexión se agote. Después de que una monitorización agote su tiempo, la CLI deja de monitorear el comando. |
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. |