백업 컴플라이언스 정책 설정 업데이트
지정된 프로젝트에 대한 백업 컴플라이언스 정책 설정을 업데이트합니다. 이 리소스를 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 지원 중단된 버전: v2-{2023-01-01}
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
비준수 백업 정책을 새 데이터 보호 설정으로 덮어쓸지 여부를 나타내는 플래그입니다.
기본값은
true입니다. -
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은
false입니다.Prettyprint
body
필수 사항
새로운 백업 컴플라이언스 정책 설정.
-
추가 스냅샷 리전이 제거되더라도 클러스터 사용자가 다른 리전으로 복사된 백업을 삭제할 수 없도록 할지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.
기본값은
false입니다. -
백업 컴플라이언스 정책이 있는 모든 클러스터에 고객 키 관리를 사용한 저장 시 암호화가 필요한지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.
기본값은
false입니다.고객 키 관리를 사용한 미사용 암호화 -
온디맨드 정책에 대한 사양.
-
클러스터가 백업 컴플라이언스 정책과 함께 지속적 클라우드 백업을 사용하는지 여부를 나타내는 플래그. 지정하지 않으면 이 값에는 기본값 false가 사용됩니다.
기본값은
false입니다.지속적인 클라우드 백업 -
백업 컴플라이언스 정책에 대한 프로젝트를 식별하는 고유한 24자리 16진수 문자열.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
백업 컴플라이언스 정책이 적용된 지속적 클라우드 백업으로 복원할 수 있는 이전 날짜 수. 0이 아닌 양의 정수를 지정해야 하며 최대 보존 기간은 시간당 보존 시간을 초과할 수 없습니다. 이 매개 변수는 백업 컴플라이언스 정책이 적용되는 지속적 클라우드 백업에만 적용됩니다.
-
예약된 하나의 정책에 대한 사양이 포함된 목록.
예약된 정책의 사양입니다.
atlas api cloudBackups updateGroupBackupCompliancePolicy --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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.2024-05-30+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.2024-05-30+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"
}