Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a las descripciones. El punto final se mantiene como se indica en el documento.

URL base: https://{OPSMANAGER-HOST}:{PORT}/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 del que desea obtener el cronograma de snapshot.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre
Descripción

status

Código de respuesta HTTP

content

Cuerpo de respuesta esperado

false

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Nombre
Tipo
Descripción

clusterCheckpointIntervalMin

Número

Número de minutos entre los puntos de control sucesivos del clúster. Esto solo se aplica a clústeres fragmentados. Este número determina el nivel de detalle de las restauraciones a un punto específico del tiempo para los clústeres. Ops Manager puede devolver valores de 15, 30 o 60.

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 que se conservarán las instantáneas diarias. Ops Manager puede devolver valores entre 1 y 365, ambos inclusive.

Configurar dailySnapshotRetentionDays en 0 desactiva esta regla.

fullIncrementalDayOfWeek

string

Día de la semana en que Ops Manager toma una instantánea completa. Esto garantiza una copia de seguridad completa y reciente. Ops Manager establece el valor predeterminado en SUNDAY.

groupId

string

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

links

objeto arreglo

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 snapshots mensuales. Ops Manager puede devolver valores entre 1 y 36, inclusives.

Configurar monthlySnapshotRetentionMonths en 0 desactiva esta regla.

pointInTimeWindowHours

Número

Número de horas en el pasado para las que se puede crear una snapshot puntual.

referenceHourOfDay

Número

Hora del día para programar instantáneas con un formato de 24 horas. Ops Manager puede devolver valores entre 0 y 23, ambos inclusive.

referenceMinuteOfHour

Número

Minuto de la hora para programar snapshots. Ops Manager puede devolver valores entre 0 y 59, ambos inclusive.

referenceTimeZoneOffset

string

El desfase horario ISO-8601 en el que se encuentra el host de Ops Manager. Para evitar problemas con el horario de verano, utiliza UTC. El valor por defecto es +0000, que es equivalente a UTC. Z también es un valor admitido y equivalente a UTC.

Ops Manager convierte cualquier desplazamiento diferente de +0000 a +0000 antes de almacenarlo, y ajusta en consecuencia el valor referenceHourOfDay.

Por ejemplo, pasas una solicitud con un referenceHourOfDay de 5 y un referenceTimeZoneOffset de "+0200". |onprem| stores a ``referenceHourOfDay de 3 y un referenceTimeZoneOffset de "+0000".

snapshotIntervalHours

Número

Número de horas entre instantáneas. El administrador de operaciones puede devolver valores de 6, 8, 12 o 24.

snapshotRetentionDays

Número

Número de días para conservar las snapshots recientes. Ops Manager puede devolver valores entre 2 y 5, inclusive.

weeklySnapshotRetentionWeeks

Número

Número de semanas para conservar snapshots semanales. Ops Manager puede devolver valores entre 1 y 52, inclusive.

Configurar weeklySnapshotRetentionWeeks en 0 desactiva esta regla.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://<OpsManagerHost>:<Port>/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

Cronograma de instantáneas

En esta página