Atlas 백업 일정 업데이트
Modify the backup schedule for the specified cluster for your project.
The backup schedule defines when MongoDB takes scheduled snapshots and how long it stores those snapshots.
이 명령을 사용하려면 프로젝트 소유자 역할이 있는 사용자 계정 또는 API 키로 인증해야 합니다.
구문
atlas backups schedule update [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
---|---|---|---|
--autoExport | 거짓 | Flag that enables automatic export of cloud backup snapshots to the AWS bucket. Mutually exclusive with --noAutoExport, --file. | |
--clusterName | 문자열 | true | 클러스터의 이름입니다. 자세한 내용은 https://dochub.mongodb.org/core/create-cluster-api를 참조하세요. |
--exportBucketId | 문자열 | 거짓 | Atlas가 버킷에 할당하는 고유 식별자입니다. --file과 상호 배타적입니다. |
--exportFrequencyType | 문자열 | 거짓 | Frequency associated with the export policy. Value can be daily, weekly, or monthly. --file과 상호 배타적입니다. |
-f, --file | 문자열 | 거짓 | Path to an optional JSON configuration file that defines backup schedule settings. To learn about the cloud backup configuration file for the Atlas CLI, see https://dochub.mongodb.org/core/cloud-backup-config-file. Mutually exclusive with --exportBucketId, --exportFrequencyType, --referenceHourOfDay, --referenceMinuteOfHour, --restoreWindowDays, --autoExport, --noAutoExport, --updateSnapshots, --noUpdateSnapshots, --useOrgAndGroupNamesInExportPrefix, --noUseOrgAndGroupNamesInExportPrefix, --policy. |
-h, --help | 거짓 | 업데이트 도움말 | |
--noAutoExport | 거짓 | Flag that disables automatic export of cloud backup snapshots to the AWS bucket. Mutually exclusive with --autoExport, --file. | |
--noUpdateSnapshots | 거짓 | Flag that disables applying the retention changes in the updated backup policy to snapshots that Atlas took previously. Mutually exclusive with --updateSnapshots, --file. | |
--noUseOrgAndGroupNamesInExportPrefix | 거짓 | Flag that disables usage of organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. Mutually exclusive with --useOrgAndGroupNamesInExportPrefix, --file. | |
-o, --output | 문자열 | 거짓 | 출력 형식입니다. 유효한 값은 json, json-path, go-템플릿 또는 go-템플릿 파일입니다. 전체 출력을 보려면 -o json 옵션을 사용합니다. |
--policy | 문자열 배열 | 거짓 | Array containing a document for each backup policy item in the desired updated backup policy. You must specify it in a format: '--policy policyID,policyItemID,frequencyType,frequencyIntervalNumber,retentionUnit,retentionValue'. --file과 상호 배타적입니다. |
--projectId | 문자열 | 거짓 | 사용할 프로젝트를 식별하는 16진수 문자열입니다. 이 옵션은 구성 파일 또는 환경 변수의 설정을 재정의합니다. |
--referenceHourOfDay | int | 거짓 | Hour of the day to schedule snapshots using a 24-hour clock. Accepted values are between 0 and 23 inclusive. --file과 상호 배타적입니다. |
--referenceMinuteOfHour | int | 거짓 | Minute of the hour to schedule snapshots. Accepted values are between 0 and 59 inclusive. --file과 상호 배타적입니다. |
--restoreWindowDays | int | 거짓 | 연속 cloud 백업의 정확도로 복원할 수 있는 과거 일수입니다. 0이 아닌 양의 정수여야 합니다. 지속적인 cloud 백업에만 적용됩니다. --file과 상호 배타적입니다. |
--updateSnapshots | 거짓 | Flag that enables applying the retention changes in the updated backup policy to snapshots that Atlas took previously. Mutually exclusive with --noUpdateSnapshots, --file. | |
--useOrgAndGroupNamesInExportPrefix | 거짓 | Flag that enables usage of organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. Mutually exclusive with --noUseOrgAndGroupNamesInExportPrefix, --file. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일에서 사용할 프로필의 이름입니다. Atlas CLI의 프로필에 대해 자세히 알아보려면 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
출력
명령이 성공하면 Atlas CLI는 다음 샘플과 유사한 출력을 반환합니다. 괄호 안의 값은 사용자의 값을 나타냅니다.
Snapshot backup policy for cluster '<ClusterName>' updated.
예시
# Update a snapshot backup policy for a cluster named Cluster0 to back up snapshots every 6 hours and, retain for 7 days, and update retention of previously-taken snapshots: atlas backup schedule update --clusterName Cluster0 --updateSnapshots --policy 62da8faac84a2721e448d767,62da8faac84a2721e448d768,hourly,6,days,7
# Update a snapshot backup policy for a cluster named Cluster0 to export snapshots monthly to an S3 bucket: atlas backup schedule update --clusterName Cluster0 --exportBucketId 62c569f85b7a381c093cc539 --exportFrequencyType monthly