Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal 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 cronograma de snapshot deseas actualizar. |
Parámetros de Solicitud Query
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 respuesta debe estar en un prettyprint formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Nombre | Tipo | Necesidad | Descripción |
|---|---|---|---|
| Número | Opcional | 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. Puede establecer un valor de IMPORTANTE: Puedes utilizar 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 para conservar instantáneas diarias. Puedes establecer un valor entre Configurar |
| string | Opcional | Día de la semana en que Cloud Manager toma una snapshot completa. Esto garantiza una copia de seguridad completa reciente. Cloud Manager establece el valor por defecto en un día laborable aleatorio. |
| string | Opcional | Identificador único del proyecto propietario de la configuración de respaldo. |
| Arreglo de objetos | Opcional | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los |
| Número | Opcional | Número de meses para conservar snapshots mensuales. Puedes establecer un valor entre Configurar |
| Número | Opcional | Número de horas entre instantáneas. Puede establecer un valor de |
| Número | Opcional | Número de días para mantener las snapshot recientes. Puedes establecer un valor entre |
| Número | Opcional | Número de semanas para conservar las instantáneas semanales. Puede establecer un valor entre Configurar |
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: Puedes utilizar 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 Configurar |
| string | Día de la semana en que Cloud Manager toma una snapshot completa. Esto garantiza una copia de seguridad completa reciente. Cloud Manager establece el valor por defecto en un día laborable aleatorio. |
| string | Identificador único del proyecto propietario de la configuración de respaldo. |
| Arreglo de objetos | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los |
| Número | Número de meses para conservar snapshots mensuales. Cloud Manager puede devolver valores entre Configurar |
| Número | Cantidad de horas en el pasado para las que se puede crear una snapshot en un punto determinado. No puedes cambiar este valor para una snapshot. |
| Número | Número de horas entre instantáneas. Cloud Manager puede devolver valores de |
| Número | Número de días para mantener las snapshot recientes. Cloud Manager puede devolver valores entre |
| Número | Número de semanas para retener los snapshots semanales. Cloud Manager puede devolver valores entre Configurar |
Solicitud de ejemplo
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 }'
Respuesta de ejemplo
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}
Respuesta del cuerpo
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 }