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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/CLUSTER-ID/snapshotSchedule
Request Parameters
Parámetros de la ruta de solicitud
Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
| string | Requerido | Identificador único del proyecto que contiene el clúster con la programación de instantáneas que desea obtener. |
| string | Requerido | Identificador único del clúster cuyo programa de instantáneas desea obtener. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
| 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. Ops Manager puede devolver valores de ImportantePuede usar puntos de control para clústeres que ejecutan MongoDB con la versión de compatibilidad de funciones 4.0 o anterior. Se eliminaron los puntos de control de las instancias de MongoDB con la versión de compatibilidad de funciones 4.2 o posterior. |
| string | Identificador único del clúster al que se aplica esta configuración de copia de seguridad. |
| Número | Número de días que se conservarán las instantáneas diarias. Ops Manager puede devolver valores entre NotaEstablecer |
| 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. |
| string | Identificador único del proyecto propietario de la configuración de respaldo. |
| matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
| Número | Número de meses para conservar snapshots mensuales. Ops Manager puede devolver valores entre NotaEstablecer |
| Número | Número de horas del pasado para las que se puede crear una instantánea de un punto en el tiempo. |
| Número | Hora del día para programar instantáneas con un reloj de 24 horas. Ops Manager puede devolver valores entre |
| Número | Minuto de la hora para programar instantáneas. Ops Manager puede devolver valores entre |
| string | La diferencia horaria ISO-8601 donde se encuentra el host de Ops Manager. Para evitar problemas con el horario de verano, utilice UTC. El valor Ops Manager convierte cualquier desplazamiento distinto de EjemploPasa una solicitud con un |
| Número | Número de horas entre instantáneas. Ops Manager puede devolver valores de |
| Número | Número de días que se conservarán las instantáneas recientes. Ops Manager puede devolver valores entre |
| Número | Número de semanas para conservar las instantáneas semanales. Ops Manager puede devolver valores entre NotaEstablecer |
Ejemplo de solicitud
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"
Ejemplo de respuesta
Encabezado de respuesta
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
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}
Cuerpo de respuesta
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 }