Docs Menu
Docs Home
/ /

Obtenga el cronograma de snapshot

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/backupConfigs/CLUSTER-ID/snapshotSchedule
Parameter
Tipo
Necesidad
Descripción

PROJECT-ID

string

Requerido

Identificador único del proyecto que contiene el clúster con la programación de instantáneas que desea obtener.

CLUSTER-ID

string

Requerido

Identificador único del clúster cuyo programa de instantáneas desea obtener.

Los siguientes parámetros de consulta son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonita

booleano

Opcional

false

envolvente

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuestaHTTP

content

Cuerpo de respuesta esperado

false

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Nombre
Tipo
Descripción

clusterCheckpointIntervalMin

Número

Número de minutos entre puntos de control sucesivos del clúster. Esto solo aplica a clústeres fragmentados. Este número determina la granularidad de las restauraciones puntuales para clústeres fragmentados. Cloud Manager puede devolver valores de 15, 30 o 60.

IMPORTANTE: Puede usar puntos de control para clústeres que ejecutan MongoDB con Feature Compatibility Version de 4.0 o anterior. Los puntos de control se eliminaron de las instancias de MongoDB con 4FCV.2 o posterior.

clusterId

string

Identificador único del clúster al que se aplica esta configuración de copia de seguridad.

dailySnapshotRetentionDays

Número

Número de días para conservar las instantáneas diarias. Cloud Manager puede devolver valores entre 1 y 365, ambos inclusive.

Establecer dailySnapshotRetentionDays en 0 deshabilita esta regla.

fullIncrementalDayOfWeek

string

Día de la semana en que Cloud Manager toma una instantánea completa. Esto garantiza una copia de seguridad completa y reciente. Cloud Manager establece el valor predeterminado en un día laborable aleatorio.

groupId

string

Identificador único del proyecto propietario de la configuración de respaldo.

links

matriz de objetos

Uno o más enlaces a subrecursos o recursos relacionados. Todas las links matrices en las respuestas incluyen al menos un enlace self llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.

monthlySnapshotRetentionMonths

Número

Número de meses para conservar las instantáneas mensuales. Cloud Manager puede devolver valores entre 1 y 36, ambos inclusive.

Establecer monthlySnapshotRetentionMonths en 0 deshabilita esta regla.

pointInTimeWindowHours

Número

Número de horas del pasado para las que se puede crear una instantánea. No se puede cambiar este valor para una instantánea.

snapshotIntervalHours

Número

Número de horas entre instantáneas. Cloud Manager puede devolver valores de 6, 8, 12 o 24.

snapshotRetentionDays

Número

Número de días para conservar las instantáneas recientes. Cloud Manager puede devolver valores entre 2 y 5, ambos inclusive.

weeklySnapshotRetentionWeeks

Número

Número de semanas para conservar las instantáneas semanales. Cloud Manager puede devolver valores entre 1 y 52, ambos inclusive.

Establecer weeklySnapshotRetentionWeeks en 0 deshabilita esta regla.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
1{
2 "clusterId" : "{CLUSTER-ID}",
3 "dailySnapshotRetentionDays" : 7,
4 "groupId" : "{PROJECT-ID}",
5 "links" : [],
6 "monthlySnapshotRetentionMonths" : 13,
7 "pointInTimeWindowHours": 24,
8 "snapshotIntervalHours" : 6,
9 "snapshotRetentionDays" : 2,
10 "weeklySnapshotRetentionWeeks" : 4
11}

Volver

Programación de instantáneas

En esta página