Actualizar la programación de copias de seguridad en la nube para un clúster
Obsoleto
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 ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan 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 consulta
-
Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
Actualiza la programación de copias de seguridad en la nube para un clúster dentro del proyecto especificado.
Nota: En el cuerpo de la solicitud, proporcione solo los campos que desea actualizar.
-
Bandera que indica si MongoDB Cloud exporta automáticamente instantáneas de Cloud Backup al depósito de exportación.
-
Marca que indica si la configuración de copia usa
copyPolicyItemsen lugar defrequencies. Si es verdadero, las solicitudes deben proporcionarcopyPolicyItemsy las respuestas solo devuelvencopyPolicyItems. Si es falso o se omite, las solicitudes deben proporcionarfrequenciesy las respuestas solo devuelvenfrequencies. -
Lista que contiene un documento para cada elemento de configuración de copia en la política de copia de seguridad deseada.
Copie el elemento de configuración en la política de respaldo deseada.
-
Lista que contiene un documento para cada configuración de copia eliminada cuyas copias de seguridad desea eliminar.
Configuración de copia eliminada cuyas copias de seguridad también deben eliminarse.
-
Marca que indica si se deben eliminar las copias de instantáneas que MongoDB Cloud tomó previamente cuando sus
copyPolicyItemsasociados se eliminan de uncopySetting. Esta opción requiere quecopyPolicyItemsEnabledsea verdadero. -
Bandera que indica si se deben eliminar las instantáneas que MongoDB Cloud tomó previamente al eliminar la política de respaldo 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.
Elemento de configuración de retención adicional en la política de copia de seguridad deseada.
-
Reglas establecidas para esta programación de copias de seguridad.
Lista que contiene un documento para cada elemento de la política de respaldo en la política de respaldo deseada.
No más de
1elemento. -
Hora del día en Tiempo Universal Coordinado (UTC) que representa cuándo MongoDB Cloud toma la instantánea.
-
Minuto del
referenceHourOfDayque representa cuando MongoDB Cloud 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.
-
Bandera que indica si se deben aplicar los cambios de retención en la política de respaldo actualizada a las instantáneas que MongoDB Cloud tomó anteriormente.
-
Bandera que indica si se deben utilizar nombres de organización y proyecto en lugar de UUID de organización y proyecto en la ruta a los archivos de metadatos que MongoDB Cloud carga en su Export Bucket.
atlas api cloudBackups updateBackupSchedule --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateGroupClusterBackupScheduleApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
UpdateGroupClusterBackupScheduleWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule" \
-d '{ <Payload> }'{
"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"
}