Actualiza el cronograma de copias de seguridad en la nube de un clúster dentro del proyecto especificado. Este cronograma define cuándo MongoDB Cloud realiza snapshots programadas y cuánto tiempo almacena esas snapshots. Para utilizar este recurso, la Cuenta de Servicio solicitante o la Clave API debe tener el rol de Propietario del Proyecto.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica el clúster.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Actualiza el cronograma de copia de seguridad en la nube para un clúster dentro del Proyecto especificado.
Nota: En el cuerpo de la solicitud, proporcione únicamente los campos que desea actualizar.
-
Indicador que indica si MongoDB Cloud exporta automáticamente los snapshot de copias de seguridad en la nube al Bucket de exportación.
-
Indicador que indica si la configuración de copia utiliza
copyPolicyItemsen lugar defrequencies. Cuando es verdadero, las solicitudes deben proporcionarcopyPolicyItems, y las respuestas solo devuelvencopyPolicyItems. Cuando es falso o se omite, las solicitudes deben suministrarfrequenciesy las respuestas devuelven solofrequencies. -
Lista que contiene un documento para cada elemento de configuración de copia en la política de copia de seguridad deseada.
-
Lista que contiene un documento para cada configuración de copia borrada cuyas copias de seguridad deseas eliminar.
-
Indicador que indica si se deben borrar las copias de Snapshot que MongoDB Nube tomó previamente cuando sus
copyPolicyItemsasociados se eliminan de uncopySetting. Esta opción requiere quecopyPolicyItemsEnabledsea verdadero. -
Bandera que indica si se deben borrar los snapshots que MongoDB nube tomó previamente al borrar la política de copia de seguridad asociada.
-
Política para exportar automáticamente snapshots de copias de seguridad en la nube.
-
Lista que contiene un documento para cada elemento de configuración de retención adicional en la política de respaldo deseada.
-
Reglas establecidas para este cronograma de copia de seguridad.
No más de
1elementos. -
Hora del día en la Hora Universal Coordinada (UTC) que representa cuando MongoDB Cloud toma la snapshot.
-
Minuto del
referenceHourOfDayque representa cuando MongoDB nube toma el snapshot. -
Número de días anteriores a los que puedes restaurar con la precisión de copia de seguridad continua en la nube. Debes especificar un número entero positivo y distinto de cero. Este parámetro aplica únicamente a las copias de seguridad continuas en la nube.
-
Bandera que indica si se deben aplicar los cambios de retención para los elementos de política de copia actualizados a las copias instantáneas que MongoDB Cloud tomó anteriormente.
-
Marca que indica si se deben aplicar los cambios de retención en la política de copia de seguridad actualizada a las instantáneas que MongoDB Cloud tomó previamente.
-
Indicador que señala si se deben utilizar nombres de organización y proyecto en lugar de UUIDs de organización y proyecto en la ruta hacia los archivos de metadatos que MongoDB Cloud carga en tu Export Bucket.
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/backup/schedule' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"autoExportEnabled":true,"copyPolicyItemsEnabled":true,"copySettings":[{"cloudProvider":"AWS","copyPolicyItems":[{"frequencyType":"ondemand"}],"frequencies":["HOURLY"],"lastNumberOfSnapshots":42,"regionName":"string","replicationSpecId":"32b6e34b3d91647abb20e7b8","shouldCopyOplogs":true}],"deleteCopiedBackups":[{"cloudProvider":"AWS","regionName":"string","replicationSpecId":"32b6e34b3d91647abb20e7b8","zoneId":"32b6e34b3d91647abb20e7b8"}],"deleteCopySnapshots":true,"deleteSnapshots":true,"export":{"exportBucketId":"32b6e34b3d91647abb20e7b8","frequencyType":"monthly"},"extraRetentionSettings":[{"frequencyType":"HOURLY","retentionDays":42}],"policies":[{"id":"32b6e34b3d91647abb20e7b8","policyItems":[{"frequencyInterval":1,"frequencyType":"daily","retentionUnit":"days","retentionValue":42}]}],"referenceHourOfDay":42,"referenceMinuteOfHour":42,"restoreWindowDays":42,"updateCopySnapshots":true,"updateSnapshots":true,"useOrgAndGroupNamesInExportPrefix":true}'{
"autoExportEnabled": true,
"copyPolicyItemsEnabled": true,
"copySettings": [
{
"cloudProvider": "AWS",
"copyPolicyItems": [
{
"frequencyType": "ondemand"
}
],
"frequencies": [
"HOURLY"
],
"lastNumberOfSnapshots": 42,
"regionName": "string",
"replicationSpecId": "32b6e34b3d91647abb20e7b8",
"shouldCopyOplogs": true
}
],
"deleteCopiedBackups": [
{
"cloudProvider": "AWS",
"regionName": "string",
"replicationSpecId": "32b6e34b3d91647abb20e7b8",
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"deleteCopySnapshots": true,
"deleteSnapshots": true,
"export": {
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [
{
"frequencyType": "HOURLY",
"retentionDays": 42
}
],
"policies": [
{
"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 42
}
]
}
],
"referenceHourOfDay": 42,
"referenceMinuteOfHour": 42,
"restoreWindowDays": 42,
"updateCopySnapshots": true,
"updateSnapshots": true,
"useOrgAndGroupNamesInExportPrefix": true
}{
"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copyPolicyItemsEnabled": true,
"copySettings": [
{
"cloudProvider": "AWS",
"copyPolicyItems": [
{
"frequencyType": "ondemand",
"id": "32b6e34b3d91647abb20e7b8"
}
],
"frequencies": [
"HOURLY"
],
"lastNumberOfSnapshots": 42,
"regionName": "string",
"replicationSpecId": "32b6e34b3d91647abb20e7b8",
"shouldCopyOplogs": true
}
],
"export": {
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [
{
"frequencyType": "HOURLY",
"retentionDays": 42
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2026-05-04T09:42:00Z",
"policies": [
{
"id": "32b6e34b3d91647abb20e7b8",
"policyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 42
}
]
}
],
"referenceHourOfDay": 42,
"referenceMinuteOfHour": 42,
"restoreWindowDays": 42,
"useOrgAndGroupNamesInExportPrefix": true
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}