Vista previa p煤blica: proporcione comentarios: elimina la instant谩nea especificada.
El subcomando de la API de Atlas, generado autom谩ticamente a partir de la API de administraci贸n de MongoDB Atlas, ofrece cobertura total de la API de administraci贸n y actualmente se encuentra en Vista Previa P煤blica (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentaci贸n del endpoint de API proporcionado.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de administrador de respaldo del proyecto.
Este comando se genera autom谩ticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-deletereplicasetbackup.
Para obtener m谩s informaci贸n y ejemplos, consulte la documentaci贸n de la API referenciada en el enlace anterior.
Sintaxis
atlas api cloudBackups deleteReplicaSetBackup [options]
opciones
Nombre | Tipo | Requerido | Descripci贸n |
|---|---|---|---|
--clusterName | string | true | Etiqueta legible por humanos que identifica el cl煤ster. |
--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. |
--ID de grupo | 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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el t茅rmino "grupos". |
-h, --ayuda | false | Ayuda para deleteReplicaSetBackup | |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | 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 formato prettyprint. | |
--snapshotId | string | true | Cadena 煤nica de 24 d铆gitos hexadecimales que identifica la instant谩nea deseada. |
--versi贸n | string | false | Versi贸n de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la 煤ltima versi贸n o el valor de configuraci贸n api_version de los perfiles si est谩 configurado. Este valor predeterminado es "2023-01-01". |
-w, --watch | false | Bandera que indica si se debe observar el comando hasta que complete su ejecuci贸n o se agote el tiempo de observaci贸n. | |
--watchTimeout | Int | false | Tiempo en segundos hasta que se agota el tiempo de vigilancia. Tras el tiempo de vigilancia, 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. |
Ejemplos
atlas api cloudBackups deleteReplicaSetBackup --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8 --snapshotId [snapshotId]