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.
Resource
PATCH /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 actualizar. |
| string | Requerido | Identificador único del clúster cuyo programa de instantáneas desea actualizar. |
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
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Número | Opcional | 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. Puede establecer un valor de IMPORTANTE: Puede usar puntos de control para clústeres que ejecutan MongoDB con |
| string | Opcional | Identificador único del clúster al que se aplica esta configuración de copia de seguridad. |
| Número | Opcional | Número de días que se conservarán las instantáneas diarias. Puede establecer un valor entre Establecer |
| string | Opcional | 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. |
| string | Opcional | Identificador único del proyecto propietario de la configuración de respaldo. |
| matriz de objetos | Opcional | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
| Número | Opcional | Número de meses para conservar las instantáneas mensuales. Puede establecer un valor entre Establecer |
| Número | Opcional | Número de horas entre instantáneas. Puede establecer un valor de |
| Número | Opcional | Número de días para guardar las instantáneas recientes. Puede establecer un valor entre |
| Número | Opcional | Número de semanas para conservar las instantáneas semanales. Puede establecer un valor entre Establecer |
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. Cloud Manager puede devolver valores de IMPORTANTE: Puede usar puntos de control para clústeres que ejecutan MongoDB con |
| string | Identificador único del clúster al que se aplica esta configuración de copia de seguridad. |
| Número | Número de días para conservar las instantáneas diarias. Cloud Manager puede devolver valores entre Establecer |
| 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. |
| 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 las instantáneas mensuales. Cloud Manager puede devolver valores entre Establecer |
| 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. |
| Número | Número de horas entre instantáneas. Cloud Manager puede devolver valores de |
| Número | Número de días para conservar las instantáneas recientes. Cloud Manager puede devolver valores entre |
| Número | Número de semanas para conservar las instantáneas semanales. Cloud Manager puede devolver valores entre Establecer |
Ejemplo de solicitud
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \ 6 --data ' 7 { 8 "fullIncrementalDayOfWeek":"TUESDAY", 9 "snapshotIntervalHours": 8, 10 "dailySnapshotRetentionDays": 15, 11 "monthlySnapshotRetentionMonths": 6 12 }'
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" : 15, 4 "fullIncrementalDayOfWeek":"TUESDAY", 5 "groupId" : "{PROJECT-ID}", 6 "links" : [], 7 "monthlySnapshotRetentionMonths" : 6, 8 "pointInTimeWindowHours": 24, 9 "snapshotIntervalHours" : 8, 10 "snapshotRetentionDays" : 2, 11 "weeklySnapshotRetentionWeeks" : 4 12 }