Actualizar la configuración de la política de cumplimiento de copias de seguridad
Actualiza la configuración de la política de cumplimiento de copias de seguridad del proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de propietario del proyecto. Versiones obsoletas: v2-{2023-01-01}
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})$.
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 se deben sobrescribir o no las políticas de respaldo no compatibles con las nuevas configuraciones de protección de datos.
El valor predeterminado es
true. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita
Cuerpo
Requerido
La nueva configuración de la Política de cumplimiento de copias de seguridad.
-
Marca que indica si se debe impedir que los usuarios del clúster eliminen copias de seguridad copiadas a otras regiones, incluso si se eliminan esas regiones de instantáneas adicionales. Si no se especifica, el valor predeterminado es "false".
El valor predeterminado es
false. -
Indicador que indica si se requiere el cifrado en reposo mediante la administración de claves del cliente para todos los clústeres con una política de cumplimiento de copias de seguridad. Si no se especifica, el valor predeterminado es falso.
El valor predeterminado es
false.Cifrado en reposo usando Custo... -
Especificaciones para la política bajo demanda.
-
Bandera que indica si el clúster utiliza copias de seguridad continuas en la nube con una política de cumplimiento de copia de seguridad. Si no se especifica, este valor es "false" por defecto.
El valor predeterminado es
false.Copias de seguridad continuas en la nube -
string única de 24 dígitos hexadecimales que identifica el Proyecto para la Política de cumplimiento de copia de seguridad.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Número de días anteriores que se pueden restaurar con Copias de Seguridad Continuas en la Nube con una Política de Cumplimiento de Copias de Seguridad. Debe especificar un número entero positivo distinto de cero, y el período de retención máximo no puede superar el tiempo de retención por hora. Este parámetro solo se aplica a Copias de Seguridad Continuas en la Nube con una Política de Cumplimiento de Copias de Seguridad.
-
Lista que contiene las especificaciones de una política programada.
Especificaciones para la política programada.
atlas api cloudBackups updateCompliancePolicy --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231001001/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.UpdateGroupBackupCompliancePolicyApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
UpdateGroupBackupCompliancePolicyWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
--header "Content-Type: application/json" \
-X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-10-01+json" \
--header "Content-Type: application/json" \
-X PUT "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" \
-d '{ <Payload> }'{
"authorizedEmail": "hello@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {
"frequencyInterval": 0,
"frequencyType": "ondemand",
"retentionUnit": "days",
"retentionValue": 42
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 42,
"scheduledPolicyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"retentionUnit": "days",
"retentionValue": 42
}
]
}{
"authorizedEmail": "hello@example.com",
"authorizedUserFirstName": "string",
"authorizedUserLastName": "string",
"copyProtectionEnabled": false,
"deletable": false,
"encryptionAtRestEnabled": false,
"onDemandPolicyItem": {
"frequencyInterval": 0,
"frequencyType": "ondemand",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 42
},
"pitEnabled": false,
"projectId": "32b6e34b3d91647abb20e7b8",
"restoreWindowDays": 42,
"scheduledPolicyItems": [
{
"frequencyInterval": 1,
"frequencyType": "daily",
"id": "32b6e34b3d91647abb20e7b8",
"retentionUnit": "days",
"retentionValue": 42
}
],
"state": "ACTIVE",
"updatedDate": "2026-05-04T09:42:00Z",
"updatedUser": "hello@example.com"
}{
"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"
}