Atualizar configurações da política de compliance de backup
Atualiza as configurações da Política de Conformidade de Backup para o projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto. Versões obsoletas: v2-{2023-01-01}
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na consulta. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.O valor padrão é
false. -
Sinalização que indica se as políticas de backup não conformes devem ser substituídas pelas novas configurações de proteção de dados.
O valor padrão é
true. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
As novas configurações da Política de compliance de backup.
-
Sinalizador que indica se deve impedir que usuários de clusters excluam backups copiados para outras regiões, mesmo que essas regiões de snapshot adicionais sejam removidas. Se não for especificado, esse valor assumirá falso como padrão.
O valor padrão é
false. -
Sinalizador que indica se a Encryption at rest usando o Gerenciamento de chaves do consumidor é necessária para todos os clusters com uma Política de compliance de backup. Se não for especificado, esse valor assumirá falso como padrão.
O valor padrão é
false.Criptografia em repouso usando o gerenciamento de chaves de cliente -
Especificações para a política on-demand.
-
Sinalizador que indica se o cluster usa backups contínuos em nuvem com uma Política de compliance de backup. Se não for especificado, esse valor assumirá falso como padrão.
O valor padrão é
false.Backups contínuos da nuvem -
String exclusiva de 24 dígitos hexadecimais que identifica o projeto para a Política de Conformidade de Backup.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$. -
Número de dias anteriores para os quais você pode restaurar com o backup contínuo na nuvem com uma política de compliance de backup. Você deve especificar um número inteiro positivo, diferente de zero, e a janela de retenção máxima não pode exceder o tempo de retenção por hora. Esse parâmetro se aplica somente aos backups contínuos na nuvem com uma política de compliance de backup.
-
Lista que contém as especificações de uma política agendada.
Especificações para a política programada.
atlas api cloudBackups updateGroupBackupCompliancePolicy --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.UpdateGroupBackupCompliancePolicyApiParams{}
sdkResp, httpResp, err := client.CloudBackupsApi.
UpdateGroupBackupCompliancePolicyWithParams(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 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-11-15+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": "2025-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"
}