공개 미리 보기: 피드백 제공하세요: 지정된 프로젝트 의 한 클러스터 에 대한 모든 레거시 백업 스냅샷을 반환합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
이 리소스를 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 현재 레거시 백업으로 설정되어 있는 경우 백업 시스템이 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책은 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 지정 백업 정책을 적용한 경우, 클라우드 백업 문서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다.
이 명령은 자동으로 생성되며 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/operation-listlegacysnapshots와 1:1 에 해당합니다. .
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api legacyBackup listLegacySnapshots [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--clusterName | 문자열 | true | 클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다. |
--completed | 문자열 | 거짓 | 완료된 스냅샷만 반환할지, 완료되지 않은 스냅샷만 반환할지, 아니면 모든 스냅샷을 반환할지 지정하는 사람이 읽을 수 있는 레이블입니다. 기본적으로 MongoDB Cloud는 완료된 스냅샷만 반환합니다. |
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--groupId | 문자열 | true | 프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다. |
-h, --help | 거짓 | listLegacySnapshots 도움말 | |
--includeCount | 거짓 | 응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다. | |
--itemsPerPage | int | 거짓 | 페이지당 응답이 반환하는 항목 수입니다. |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식은 ["JSON", go- Template] 일 수 있습니다. 이 값의 기본값은 "JSON" 입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--pageNum | int | 거짓 | 응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다. |
--pretty | 거짓 | 응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다. | |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-01-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값 기본값은 '2023-01-01". |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
atlas api legacyBackup listLegacySnapshots --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8