1개의 레거시 백업 스냅샷 반환 더 이상 사용되지 않습니다.

얻다 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}

지정된 프로젝트의 클러스터 하나에 대한 레거시 백업 스냅샷 하나를 반환합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다. 2020년 3월 23일부터 모든 새 클러스터는 클라우드 백업만 사용할 수 있습니다. 4.2로 업그레이드하면, 현재 레거시 백업으로 설정되어 있는 경우 백업 시스템이 클라우드 백업으로 업그레이드됩니다. 이 업그레이드 후에도 기존의 모든 레거시 백업 스냅샷을 계속 사용할 수 있습니다. 사용자의 보유 정책에 따라 시간이 지나면 만료됩니다. 백업 정책은 기본 일정으로 재설정됩니다. 레거시 백업과 함께 사용자 지정 백업 정책을 적용한 경우, 클라우드 백업 문서에 설명된 절차에 따라 백업 정책을 다시 생성해야 합니다.

클라우드 백업 문서

경로 매개변수

  • groupId 문자열 필수 사항

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

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

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

  • clusterName 문자열 필수 사항

    클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

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

  • snapshotId 문자열 필수 사항

    원하는 스냅샷을 식별하는 고유한 24자리 16진수 문자열입니다.

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

쿼리 매개변수

  • envelope 부울

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

    기본값은 false 입니다.

  • pretty 부울

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

    기본값은 false 입니다.

    Prettyprint

응답

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

    확인

    응답 속성 숨기기 응답 속성 표시 객체
    • clusterId 문자열

      반환하려는 스냅샷이 있는 클러스터 식별하는 고유한 24-16진수 문자열입니다.

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

    • clusterName 문자열

      클러스터를 식별하는 사람이 읽을 수 있는 라벨입니다.

    • complete 부울

      스냅샷 이 존재하는지 여부를 나타내는 플래그입니다. MongoDB Cloud가 스냅샷 생성하는 동안 이 플래그는 false 를 반환합니다.

    • 생성됨 객체

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

      생성된 속성 숨기기 생성된 속성 표시 객체
      • 날짜 문자열(날짜-시간)

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

      • 증가 integer(int32)

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

        최소값은 1199145600입니다.

    • doNotDelete 부울

      다른 사람이 이 스냅샷을 삭제할 수 있는지 여부를 나타내는 플래그입니다. 동일한 요청에서 "doNotDelete" : true 설정과 만료 타임스탬프를 설정할 수 없습니다.

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

      MongoDB Cloud가 스냅샷을 삭제하는 날짜 및 시간입니다. "doNotDelete" : true인 경우 MongoDB Cloud는 이 매개변수에 설정된 모든 값을 제거합니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

    • groupId 문자열

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

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

    • id 문자열

      스냅샷 식별하는 고유한 24-16진수 문자열입니다.

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

    • 증분 부울

      증분 스냅샷인지 전체 스냅샷 인지를 나타내는 플래그입니다.

    • lastOplogAppliedTimestamp 객체

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

      lastOplogAppliedTimestamp 속성 숨기기 lastOplogAppliedTimestamp 속성 표시 객체
      • 날짜 문자열(날짜-시간)

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

      • 증가 integer(int32)

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

        최소값은 1199145600입니다.

    • 부품 배열[객체]

      전체 스냅샷 설명하는 메타데이터입니다.

      • 복제본 세트 의 경우 이 배열 에는 단일 문서 가 포함됩니다.
      • 샤딩된 클러스터 의 경우, 이 배열 에는 각 샤드 에 대한 문서 하나와 구성 호스팅하다 에 대한 문서 하나가 포함됩니다.

      이 스냅샷 식별하는 특성입니다.

      부품 속성 숨기기 부품 속성 표시 객체
      • clusterId 문자열

        반환하려는 스냅샷이 있는 클러스터 식별하는 고유한 24-16진수 문자열입니다.

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

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

        스냅샷 완료된 날짜 및 시간입니다. 이 매개변수는 UTC의 ISO 8601 타임스탬프 형식으로 값을 표현합니다.

      • 압축 설정 문자열

        스냅샷 의 압축 방법을 식별하는 사람이 읽을 수 있는 레이블입니다.

        값은 NONE 또는 GZIP입니다.

      • dataSizeBytes integer(int64)

        클러스터 의 각 노드 에 저장된 데이터의 총 크기입니다. 이 매개변수는 값을 바이트 단위로 표현합니다.

      • encryptionEnabled 부울

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

      • fcv 문자열

        MongoDB Cloud가 스냅샷 생성할 때 복제본 세트 프라이머리 가 실행한 MongoDB 의 기능 호환성 버전 나타내는 숫자입니다.

      • fileSizeBytes integer(int64)

        데이터 파일의 총 크기를 바이트 단위로 나타내는 숫자입니다.

      • machineId 문자열

        MongoDB Cloud가 스냅샷 생성한 노드 를 나타내는 호스트 이름 및 포트입니다.

        형식은 ^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?(\:[0-9]{4,5})$ 패턴 과 일치해야 합니다.

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

        스냅샷 데이터를 암호화하는 데 사용되는 KMIP(Key Management Interoperability) 마스터 키를 식별하는 고유 문자열입니다. 리소스 "parts.encryptionEnabled" : true일 때 이 매개 변수를 반환합니다.

      • mongodVersion 문자열

        MongoDB Cloud가 스냅샷 생성할 때 복제본 세트 프라이머리 실행한 MongoDB 버전을 나타내는 숫자입니다.

        형식은 ([\d]+\.[\d]+\.[\d]+) 패턴 과 일치해야 합니다.

      • 복제본 세트 이름 문자열

        복제본 세트를 식별하는 사람이 읽을 수 있는 레이블입니다.

      • replicaState 문자열

        스냅샷 프로세스 시작된 시점의 노드 역할 .

      • storageSizeBytes integer(int64)

        문서 저장 에 할당된 공간의 총 크기를 나타내는 숫자입니다.

      • typeName 문자열

        MongoDB Cloud가 이 스냅샷 만든 서버 유형을 식별하는 사람이 읽을 수 있는 레이블입니다.

        값은 REPLICA_SET, CONFIG_SERVER, CONFIG_SERVER_REPLICA_SET 또는 CONFIG_SHARD_REPLICA_SET입니다.

  • 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 상태 코드가 반환되었습니다.

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

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

    • 매개변수 배열[객체]

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

    • 이유 문자열

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

GET /API/Atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}
atlas api legacyBackup getGroupClusterSnapshot --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250312001/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.GetGroupClusterSnapshotApiParams{}
	sdkResp, httpResp, err := client.LegacyBackupApi.
		GetGroupClusterSnapshotWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-03-12+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}?pretty=true"
응답 예시(200)
{
  "clusterId": "32b6e34b3d91647abb20e7b8",
  "clusterName": "string",
  "complete": true,
  "created": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "doNotDelete": true,
  "expires": "2025-05-04T09:42:00Z",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "id": "32b6e34b3d91647abb20e7b8",
  "incremental": true,
  "lastOplogAppliedTimestamp": {
    "date": "2025-05-04T09:42:00Z",
    "increment": 1199145600
  },
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "parts": [
    {
      "clusterId": "32b6e34b3d91647abb20e7b8",
      "completedTime": "2025-05-04T09:42:00Z",
      "compressionSetting": "NONE",
      "dataSizeBytes": 42,
      "encryptionEnabled": true,
      "fcv": "string",
      "fileSizeBytes": 42,
      "machineId": "string",
      "masterKeyUUID": "string",
      "mongodVersion": "string",
      "replicaSetName": "string",
      "replicaState": "string",
      "storageSizeBytes": 42,
      "typeName": "REPLICA_SET"
    }
  ]
}
응답 예시(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"
}