1개의 레거시 백업 복원 작업 만들기 더 이상 사용되지 않습니다.

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs

지정된 프로젝트의 클러스터 한 개에 대해 레거시 백업 한 개를 복원합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 소유자 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 현재 레거시 백업으로 설정되어 있는 경우 백업 시스템이 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책은 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 지정 백업 정책을 적용한 경우, 클라우드 백업 문서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다. 이 엔드포인트는 샤딩된 클러스터에 대한 체크포인트 복원 작업 생성이나 쿼리 가능 백업 스냅샷에 대한 복원 작업 생성을 지원하지 않습니다. 요청 본문에 AUTOMATED_RESTOREdelivery.methodName을 지정하여 자동 복원 작업을 생성하는 경우, MongoDB Cloud는 복원 전에 대상 클러스터의 기존 데이터를 모두 제거합니다.

클라우드 백업 문서

경로 매개변수

  • groupId 문자열 필수 사항

    프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

    참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • clusterName 문자열 필수 사항

    반환하려는 스냅샷이 포함된 클러스터를 식별하는 사람이 읽을 수 있는 레이블입니다.

    형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

쿼리 매개변수

  • envelope 부울

    애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

    기본값은 false 입니다.

  • pretty 부울

    응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

    기본값은 false 입니다.

    Prettyprint
application/vnd.atlas.2023-01-01+json

body 필수 사항

레거시 백업으로 지정된 프로젝트의 cluster 한 개로 복원합니다.

  • checkpointId 문자열

    샤딩된 클러스터 체크포인트를 식별하는 고유한 24자리 16진수 문자열입니다. 체크포인트는 데이터를 복원하려는 시점을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE"일 때 적용됩니다. 이 매개변수는 샤딩된 클러스터에만 사용합니다.

    • checkpointId를 설정하면 oplogInc, oplogTs, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
    • 이 매개변수를 제공하면 이 엔드포인트는 이 체크포인트까지의 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • 전달 객체 필수 사항

    복원된 스냅샷 데이터를 전달하는 방법을 나타내는 메서드 및 세부 정보입니다.

    배송 속성 숨기기 배송 속성 표시 객체
    • expireHours integer(int32)

      스냅샷 다운로드 파일 의 URL (Uniform Resource Locator)이 만료되는 시점을 나타내는 복원 작업 완료된 후의 시간 수입니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

      최소값은 1입니다.

    • maxDownloads integer(int32)

      스냅샷 다운로드 파일 에 URL (Uniform Resource Locator)을 사용할 수 있는 횟수를 나타내는 양의 정수입니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

      최소값은 1입니다.

    • 메서드 이름 문자열 필수 사항

      데이터를 전달하는 수단을 식별하는 사람이 읽을 수 있는 레이블입니다. 를 설정하다 "delivery.methodName" : "AUTOMATED_RESTORE" 경우delivery.targetGroupIddelivery.targetClusterName 또는 delivery.targetClusterId도 설정하다 해야 합니다. 자동화된 "delivery.methodName" : "HTTP" 복원 HTTP(HyperText Transport Protocol)를 사용하여 복원 작업 대상 호스팅하다 에 전달하므로 응답은 를 반환합니다.

      값은 CLIENT_PIT_HTTP, QUERY, AUTOMATED_RESTORE, HTTP, THIRD_PARTY_COPY, CLIENT_PIT_SCP 또는 SCP입니다.

    • targetClusterId 문자열

      24대상 클러스터 식별하는 고유한 -16진수 문자열입니다. 모든 스냅샷 가져오기 및 스냅샷 가져오기 엔드포인트의 응답 본문에 반환된 clusterId를 사용합니다. 이 매개변수는 일 때 "delivery.methodName" : "AUTOMATED_RESTORE" 적용됩니다.

      대상 클러스터 백업 활성화되어 있지 않은 경우 두 개의 리소스는 빈 값이 포함된 매개변수를 반환합니다.

      • 모든 스냅샷가져오기 엔드포인트가 clusterId 요소가 없는 빈 결과 배열 반환합니다.
      • 스냅샷 가져오기 엔드포인트가 clusterId 매개변수를 반환하지 않습니다.

      clusterId 매개변수가 포함된 응답을 반환하려면 delivery.targetClusterName 매개변수를 사용하거나 대상 클러스터 에서 백업 활성화 .

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

    • targetClusterName 문자열

      대상 클러스터 식별하는 사람이 읽을 수 있는 레이블입니다. 모든 스냅샷 가져오기 및 스냅샷 가져오기 엔드포인트의 응답 본문에 반환된 clusterName을 사용합니다. 이 매개변수는 일 때 "delivery.methodName" : "AUTOMATED_RESTORE" 적용됩니다.

      대상 클러스터 백업 활성화되어 있지 않은 경우 두 개의 리소스는 빈 값이 포함된 매개변수를 반환합니다.

      • 모든 스냅샷가져오기 엔드포인트가 clusterId 요소가 없는 빈 결과 배열 반환합니다.
      • 스냅샷 가져오기 엔드포인트가 clusterId 매개변수를 반환하지 않습니다.

      clusterId 매개변수가 포함된 응답을 반환하려면 delivery.targetClusterName 매개변수를 사용하거나 대상 클러스터 에서 백업 활성화 .

      형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

    • targetGroupId 문자열

      복원 작업 의 대상 클러스터 포함된 프로젝트 식별하는 고유한 24-16진수 문자열입니다. 리소스 "delivery.methodName" : "AUTOMATED_RESTORE"일 때 이 매개 변수를 반환합니다.

      형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

  • oplogInc integer(int32)

    주어진 초 내의 작업을 나타내는 32비트 증분 서수입니다. oplogT와 함께 사용할 경우 이는 MongoDB Cloud가 데이터를 복원하는 시점을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다.

    • oplogInc를 설정하면 반드시 oplogT를 설정해야 하며 checkpointId, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
    • 이 매개변수를 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.

    최소값은 1입니다.

  • oplogTs 문자열

    이 스냅샷을 복원할 날짜 및 시간입니다. 이 매개변수는 값을 UTC의 ISO 8601 형식으로 표현합니다. 이는 Oplog 타임스탬프의 첫 번째 부분을 나타냅니다. oplogInc와 함께 사용하면 데이터를 복원하려는 마지막 데이터베이스 작업을 나타냅니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다. 복제본 세트에서 local.oplog.rs에 대한 쿼리를 실행하여 원하는 타임스탬프를 찾습니다.

    • oplogT를 설정하면 반드시 oplogInc를 설정해야 하며 checkpointId, snapshotId 또는 pointInTimeUTCMillis는 설정할 수 없습니다.
    • 이 매개변수를 제공하면 이 엔드포인트는 이 Oplog 타임스탬프를 포함한 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.

    형식은 ^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,9})?(?:Z|[+-][01]\\d:[0-5]\\d)$ 패턴 과 일치해야 합니다.

  • pointInTimeUTCMillis integer(int64)

    이 스냅샷을 복원하려는 타임스탬프입니다. 이 매개변수는 유닉스 시간 이후 경과된 시간(밀리초)으로 값을 표현합니다. 이 타임스탬프는 현재 시간으로부터 최근 24시간 이내여야 합니다. 이 매개변수는 "delivery.methodName" : "AUTOMATED_RESTORE" 시 적용됩니다.

    • 이 매개변수를 제공하면 이 엔드포인트는 이 시점까지의 모든 데이터를 전달 객체에서 지정한 데이터베이스에 복원합니다.
    • pointInTimeUTCMillis를 설정하면 oplogInc, oplogTs, snapshotId 또는 checkpointId는 설정할 수 없습니다.

    최소값은 1199145600000입니다.

    UNIX Epoch
  • snapshotId 문자열

    복원할 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다. snapshotId를 설정하는 경우 oplogInc, oplogTs, pointInTimeUTCMillis 또는 checkpointId는 설정할 수 없습니다.

    형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

응답

  • 200 application/vnd.atlas.2023-01-01+json

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • 결과 배열[객체]

      이 요청 을 완료할 때 MongoDB 클라우드가 제공하는 반환된 문서 목록입니다.

      결과 속성 숨기기 결과 속성 표시 객체
      • batchId 문자열

        이 복원 작업 속한 배치 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수는 샤딩된 클러스터 복원 에만 존재합니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • clusterId 문자열

        반환하려는 스냅샷 있는 클러스터 식별하는 고유한 24-16진수 문자열입니다. 이 매개변수는 클러스터 복원 에 대해 반환됩니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • clusterName 문자열

        조회 하려는 스냅샷이 포함된 클러스터 식별하는 사람이 읽을 수 있는 레이블입니다.

        형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

      • 생성됨 문자열(날짜-시간)

        누군가가 이 복원 작업 요청한 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • 전달 객체 필수 사항

        복원된 스냅샷 데이터를 전달하는 방법을 나타내는 메서드 및 세부 정보입니다.

        배송 속성 숨기기 배송 속성 표시 객체
        • authHeader 문자열

          복원 다운로드할 때 사용할 헤더 이름으로, "delivery.methodName" : "HTTP" 와 함께 사용됩니다.

        • authValue 문자열

          복원 다운로드할 때 사용할 헤더 값으로, "delivery.methodName" : "HTTP"와 함께 사용됩니다.

        • expireHours integer(int32)

          스냅샷 다운로드 파일 의 URL (Uniform Resource Locator)이 만료되는 시점을 나타내는 복원 작업 완료된 후의 시간 수입니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

          최소값은 1입니다.

        • expires 문자열(날짜-시간)

          스냅샷 다운로드 파일 의 URL (Uniform Resource Locator)이 만료되는 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

        • maxDownloads integer(int32)

          스냅샷 다운로드 파일 에 URL (Uniform Resource Locator)을 사용할 수 있는 횟수를 나타내는 양의 정수입니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

          최소값은 1입니다.

        • 메서드 이름 문자열 필수 사항

          데이터를 전달하는 수단을 식별하는 사람이 읽을 수 있는 레이블입니다. 를 설정하다 "delivery.methodName" : "AUTOMATED_RESTORE" 경우delivery.targetGroupIddelivery.targetClusterName 또는 delivery.targetClusterId도 설정하다 해야 합니다. 자동화된 "delivery.methodName" : "HTTP" 복원 HTTP(HyperText Transport Protocol)를 사용하여 복원 작업 대상 호스팅하다 에 전달하므로 응답은 를 반환합니다.

          값은 CLIENT_PIT_HTTP, QUERY, AUTOMATED_RESTORE, HTTP, THIRD_PARTY_COPY, CLIENT_PIT_SCP 또는 SCP입니다.

        • statusName 문자열

          MongoDB Cloud가 이 요청 수신했을 때 다운로드 가능한 스냅샷 파일 의 상태입니다.

          값은 NOT_STARTED, IN_PROGRESS, READY, FAILED, INTERRUPTED, EXPIRED, MAX_DOWNLOADS_EXCEEDED 또는 PENDING입니다.

        • targetClusterId 문자열

          24대상 클러스터 식별하는 고유한 -16진수 문자열입니다. 모든 스냅샷 가져오기 및 스냅샷 가져오기 엔드포인트의 응답 본문에 반환된 clusterId를 사용합니다. 이 매개변수는 일 때 "delivery.methodName" : "AUTOMATED_RESTORE" 적용됩니다.

          대상 클러스터 백업 활성화되어 있지 않은 경우 두 개의 리소스는 빈 값이 포함된 매개변수를 반환합니다.

          • 모든 스냅샷가져오기 엔드포인트가 clusterId 요소가 없는 빈 결과 배열 반환합니다.
          • 스냅샷 가져오기 엔드포인트가 clusterId 매개변수를 반환하지 않습니다.

          clusterId 매개변수가 포함된 응답을 반환하려면 delivery.targetClusterName 매개변수를 사용하거나 대상 클러스터 에서 백업 활성화 .

          형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

        • targetClusterName 문자열

          대상 클러스터 식별하는 사람이 읽을 수 있는 레이블입니다. 모든 스냅샷 가져오기 및 스냅샷 가져오기 엔드포인트의 응답 본문에 반환된 clusterName을 사용합니다. 이 매개변수는 일 때 "delivery.methodName" : "AUTOMATED_RESTORE" 적용됩니다.

          대상 클러스터 백업 활성화되어 있지 않은 경우 두 개의 리소스는 빈 값이 포함된 매개변수를 반환합니다.

          • 모든 스냅샷가져오기 엔드포인트가 clusterId 요소가 없는 빈 결과 배열 반환합니다.
          • 스냅샷 가져오기 엔드포인트가 clusterId 매개변수를 반환하지 않습니다.

          clusterId 매개변수가 포함된 응답을 반환하려면 delivery.targetClusterName 매개변수를 사용하거나 대상 클러스터 에서 백업 활성화 .

          형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

        • targetGroupId 문자열

          복원 작업 의 대상 클러스터 포함된 프로젝트 식별하는 고유한 24-16진수 문자열입니다. 리소스 "delivery.methodName" : "AUTOMATED_RESTORE"일 때 이 매개 변수를 반환합니다.

          형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

        • URL 문자열 더 이상 사용되지 않습니다.

          복원된 스냅샷 데이터를 다운로드 할 수 있는 Uniform Resource Locator( URL )입니다. URL에는 확인 키가 포함되어 있습니다. 리소스 "delivery.methodName" : "HTTP"일 때 이 매개 변수를 반환합니다.

        • urlV2 문자열

          복원된 스냅샷 데이터를 다운로드 할 수 있는 Uniform Resource Locator( URL )입니다. 이는 url 보다 선호되어야 합니다. 확인 키는 HTTP 헤더로 전송되어야 합니다. 리소스 일 때 이 매개 변수를 "delivery.methodName" : "HTTP" 반환합니다.

      • encryptionEnabled 부울

        누군가가 복원된 스냅샷 의 데이터를 암호화됨 여부를 나타내는 플래그입니다.

      • groupId 문자열

        스냅샷을 소유한 프로젝트 식별하는 고유한 24-16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 해시 배열[객체]

        각 복원 파일 해시 체크섬 에 매핑하는 문서가 포함된 목록입니다. 이 매개변수는 해당 delivery.url을 다운로드 후에 적용됩니다. 인 "methodName" : "HTTP" 경우 이 목록에는 .tar.gz 파일 의 해시를 나타내는 하나의 객체 포함됩니다.

        하나의 복원 파일 하나 해시 체크섬 에 매핑하는 키와 값 쌍입니다. 이 매개변수는 해당 delivery.url을 다운로드 후에 적용됩니다.

        해시 속성 숨기기 해시 속성 표시 객체
        • 파일 이름 문자열

          해시 파일 식별하는 사람이 읽을 수 있는 레이블입니다.

        • 해시 문자열

          복원 파일 에 매핑되는 해시된 체크섬 입니다.

        • typeName 문자열

          해시 값을 계산하는 데 사용되는 해시 알고리즘 식별하는 사람이 읽을 수 있는 레이블입니다.

          값은 SHA1입니다.

      • id 문자열

        복원 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • 마스터 키UUID 문자열(uuid)

        스냅샷 데이터를 암호화하는 데 사용되는 KMIP(Key Management Interoperability) 마스터 키를 식별하는 UUID(Universally Unique Identifier)입니다. 이 매개변수는 "encryptionEnabled" : "true"인 경우에만 적용됩니다.

      • snapshotId 문자열

        복원할 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다. snapshotId를 설정하는 경우 oplogInc, oplogTs, pointInTimeUTCMillis 또는 checkpointId는 설정할 수 없습니다.

        형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.

      • statusName 문자열

        요청 시 다운로드 가능한 파일 의 상태를 식별하는 사람이 읽을 수 있는 레이블입니다.

        값은 IN_PROGRESS, BROKEN, KILLED 또는 FINISHED입니다.

      • timestamp 객체

        oplog 에 체크포인트 토큰 항목이 발생한 시기를 나타내는 BSON 타임스탬프입니다.

        타임스탬프 속성 숨기기 타임스탬프 속성 표시 객체
        • 날짜 문자열(날짜-시간)

          oplog 이 데이터베이스 작업을 기록한 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

        • 증가 integer(int32)

          특정 날짜 및 시간에 oplog 기록한 데이터베이스 작업의 순서입니다.

          최소값은 1199145600입니다.

    • 총 개수 integer(int32)

      사용 가능한 총 문서 수입니다. MongoDB Cloud는 includeCountfalse로 설정하다 경우 이 값을 생략합니다. 총 숫자는 추정치이며 정확하지 않을 수 있습니다.

      최소값은 0입니다.

  • 400 application/json

    잘못된 요청입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 401 application/json

    승인되지 않았습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 403 application/json

    Forbidden.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 404 application/json

    찾을 수 없습니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

  • 500 application/json

    내부 서버 오류입니다.

    응답 속성 숨기기 응답 속성 표시 객체
    • badRequestDetail 객체

      요청 세부 정보가 잘못되었습니다.

      badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
      • 필드 배열[객체]

        클라이언트 요청 의 모든 위반 사항을 설명합니다.

        필드 속성 숨기기 필드 속성 표시 객체
        • description 문자열 필수 사항

          요청 요소가 잘못된 이유에 대한 설명입니다.

        • 필드 문자열 필수 사항

          요청 본문의 필드 로 연결되는 경로입니다.

    • 세부 정보 문자열

      각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.

    • 오류 integer(int32) 필수 사항

      이 오류와 함께 HTTP 상태 코드가 반환되었습니다.

      외부 문서
    • 오류 코드 문자열 필수 사항

      이 오류와 함께 반환된 애플리케이션 오류 코드입니다.

    • 매개변수 배열[객체]

      오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.

    • 이유 문자열

      이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs
atlas api legacyBackup createGroupClusterRestoreJob --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20231001001/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.CreateGroupClusterRestoreJobApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		CreateGroupClusterRestoreJobWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2023-10-01+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs" \
  -d '{ <Payload> }'
요청 예시
{
  "checkpointId": "32b6e34b3d91647abb20e7b8",
  "delivery": {
    "expirationHours": 42,
    "maxDownloads": 42,
    "methodName": "CLIENT_PIT_HTTP",
    "targetClusterId": "32b6e34b3d91647abb20e7b8",
    "targetClusterName": "string",
    "targetGroupId": "32b6e34b3d91647abb20e7b8"
  },
  "oplogInc": 42,
  "oplogTs": "string",
  "pointInTimeUTCMillis": 42,
  "snapshotId": "32b6e34b3d91647abb20e7b8"
}
응답 예시(200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "batchId": "32b6e34b3d91647abb20e7b8",
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "clusterName": "string",
      "created": "2025-05-04T09:42:00Z",
      "delivery": {
        "authHeader": "string",
        "authValue": "string",
        "expirationHours": 42,
        "expires": "2025-05-04T09:42:00Z",
        "maxDownloads": 42,
        "methodName": "CLIENT_PIT_HTTP",
        "statusName": "NOT_STARTED",
        "targetClusterId": "32b6e34b3d91647abb20e7b8",
        "targetClusterName": "string",
        "targetGroupId": "32b6e34b3d91647abb20e7b8",
        "url": "string",
        "urlV2": "string"
      },
      "encryptionEnabled": true,
      "groupId": "32b6e34b3d91647abb20e7b8",
      "hashes": [
        {
          "fileName": "string",
          "hash": "string",
          "links": [
            {
              "href": "https://cloud.mongodb.com/api/atlas",
              "rel": "self"
            }
          ],
          "typeName": "SHA1"
        }
      ],
      "id": "32b6e34b3d91647abb20e7b8",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "masterKeyUUID": "string",
      "snapshotId": "32b6e34b3d91647abb20e7b8",
      "statusName": "IN_PROGRESS",
      "timestamp": {
        "date": "2025-05-04T09:42:00Z",
        "increment": 1199145600
      }
    }
  ],
  "totalCount": 42
}
응답 예시(400)
{
  "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"
}
응답 예시(401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
응답 예시(403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
응답 예시(404)
{
  "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"
}
응답 예시(500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}