지정된 프로젝트 내 하나의 클러스터에 대한 클라우드 백업 일정을 업데이트합니다. 이 일정은 MongoDB Cloud가 예약된 스냅샷을 생성하는 시기와 해당 스냅샷을 저장하는 기간을 정의합니다. 이 리소스를 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 지원 중단된 버전: v2-{2023-01-01}
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.
형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.
애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
기본값은 false 입니다.
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은 false 입니다.
지정된 프로젝트 내 하나의 클러스터에 대한 클라우드 백업 일정을 업데이트합니다.
참고: 요청 본문에는 업데이트하려는 필드만 제공하세요.
MongoDB Cloud가 클라우드 백업 스냅샷을 내보내기 버킷으로 자동으로 내보낼지 여부를 나타내는 플래그.
원하는 백업 정책의 복사 설정 항목별 문서가 포함된 목록.
원하는 백업 정책의 설정 항목을 복사합니다.
삭제하려는 백업 복사본의 삭제된 각 복사본 설정에 대한 문서가 포함된 목록.
백업 복사본도 삭제해야 하는 삭제된 복사본 설정입니다.
관련 백업 정책을 삭제할 때 MongoDB 클라우드가 이전에 만든 스냅샷 삭제 할지 여부를 나타내는 플래그입니다.
클라우드 백업 스냅샷을 자동으로 내보내기 위한 정책입니다.
원하는 백업 정책의 추가 보존 설정 항목별 문서가 포함된 목록.
원하는 백업 정책의 추가 보존 설정 항목입니다.
이 백업 일정에 설정된 규칙.
원하는 백업 정책의 각 백업 정책 항목에 대한 문서 포함된 목록입니다.
요소가 1 개 이하입니다.
MongoDB Cloud가 스냅샷을 생성하는 시점을 나타내는 협정 세계시(UTC)로 표시된 시간.
MongoDB Cloud가 스냅샷을 생성하는 시간을 나타내는 referenceHourOfDay의 분.
지속적인 클라우드 백업의 정확성으로 다시 복원할 수 있는 이전 일수. '0'이 아닌 양의 정수를 지정해야 합니다. 이 매개 변수는 지속적인 클라우드 백업에만 적용됩니다.
MongoDB Cloud가 이전에 생성한 스냅샷에 업데이트된 백업 정책의 보존 변경 사항을 적용할지 여부를 나타내는 플래그.
MongoDB Cloud가 내보내기 버킷에 업로드하는 메타데이터 파일 경로에 조직 및 프로젝트 UUID 대신 조직 및 프로젝트 이름을 사용할지 여부를 나타내는 플래그입니다.
atlas api cloudBackups updateBackupSchedule --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/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.2024-10-23+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.2024-10-23+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,
"copySettings": [
{
"cloudProvider": "AWS",
"frequencies": [
"HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"deleteCopiedBackups": [
{
"cloudProvider": "AWS",
"regionName": "string",
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"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,
"updateSnapshots": true,
"useOrgAndGroupNamesInExportPrefix": true
}{
"autoExportEnabled": true,
"clusterId": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"copySettings": [
{
"cloudProvider": "AWS",
"frequencies": [
"HOURLY"
],
"regionName": "string",
"shouldCopyOplogs": true,
"zoneId": "32b6e34b3d91647abb20e7b8"
}
],
"export": {
"exportBucketId": "32b6e34b3d91647abb20e7b8",
"frequencyType": "monthly"
},
"extraRetentionSettings": [
{
"frequencyType": "HOURLY",
"retentionDays": 42
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"nextSnapshot": "2025-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"
}