Devuelve todas las instantáneas de respaldos heredados de un clúster en el Proyecto especificado. Para usar este recurso, la cuenta de servicio o clave de API solicitante debe tener el rol de Solo lectura de Proyecto. A partir de 23 de marzo de 2020, todos los clústeres nuevos solo pueden usar copias de seguridad en la nube. Cuando actualices a la versión 4.2, tu sistema de copia de seguridad se actualizará a copia de seguridad en la nube si actualmente está configurado con copia de seguridad heredado. Tras esta actualización, todas tus snapshots heredadas de respaldo existentes seguirán disponibles. Expiran con el tiempo de acuerdo con tu política de retención. Tu política de copia de seguridad se restablece al cronograma por defecto. Si tenías una política de copia de seguridad personalizada vigente con respaldos heredados, debes volver a crearla con el procedimiento detallado en la documentación de copias de seguridad en la nube.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 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".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
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 consulta
-
Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor predeterminado es
true. -
Número de elementos que la respuesta devuelve por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
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 es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita -
Etiqueta legible que especifica si se deben devolver solo las instantáneas completadas, incompletas o todas. De forma predeterminada, MongoDB Cloud solo devuelve las instantáneas completadas.
Los valores son
all,trueofalse. El valor predeterminado estrue.
atlas api legacyBackup listClusterSnapshots --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.ListGroupClusterSnapshotsApiParams{}
sdkResp, httpResp, err := client.LegacyBackupApi.
ListGroupClusterSnapshotsWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots?pretty=true"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"complete": true,
"created": {
"date": "2026-05-04T09:42:00Z",
"increment": 1199145600
},
"doNotDelete": true,
"expires": "2026-05-04T09:42:00Z",
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"incremental": true,
"lastOplogAppliedTimestamp": {
"date": "2026-05-04T09:42:00Z",
"increment": 1199145600
},
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"parts": [
{
"clusterId": "32b6e34b3d91647abb20e7b8",
"completedTime": "2026-05-04T09:42:00Z",
"compressionSetting": "NONE",
"dataSizeBytes": 42,
"encryptionEnabled": true,
"fcv": "string",
"fileSizeBytes": 42,
"machineId": "string",
"masterKeyUUID": "string",
"mongodVersion": "string",
"replicaSetName": "string",
"replicaState": "string",
"storageSizeBytes": 42,
"typeName": "REPLICA_SET"
}
]
}
],
"totalCount": 42
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}