AI 에이전트의 경우: 문서 인덱스는 https://www.mongodb.com/ko-kr/docs/llms.txt에서 사용할 수 있으며, 모든 페이지의 마크다운 버전은 어떤 URL 경로에 .md를 추가하여 사용할 수 있습니다.

1개의 백업 구성 업데이트

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID가 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

PATCH /groups/{projectId}/backupConfigs/{clusterId}

요청 매개변수

요청 경로 매개변수

경로 매개 변수
유형
필요성
설명

projectId

문자열

필수 사항

변경하려는 백업 구성이 있는 cluster를 보유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

clusterId

문자열

필수 사항

백업 구성을 변경하려는 cluster를 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값

pretty

부울

옵션

응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

  • status: HTTP 응답 코드

  • content예상되는 응답 본문

false

요청 본문 매개변수

이름
유형
필요성
설명

authMechanismName

문자열

조건부

동기화 소스 데이터베이스에 연결하는 데 필요한 인증 메커니즘입니다. 동기화 저장소가 인증을 사용하는 경우 Ops Manager에 이 매개 변수가 필요합니다. Ops Manager는 다음을 허용합니다.

  • MONGODB_CR (여기에는 SCRAM-SHA-1, SCRAM-SHA-256 및 MONGODB-CR이 포함됩니다.)

  • GSSAPI

  • PLAIN

  • MONGODB_X509

  • NONE

disableCertificateRevocationCheck

부울

옵션

백업 중인 MongoDB deployment 에 연결할 때 백업 에이전트 tlsDisableCertificateReventionCheck 연결 문자열 옵션을 사용해야 하는지 여부를 나타냅니다.

백업 구성이 TLS를 사용하고 백업 에이전트가 인증서 확인을 건너뛰는 경우(sslRequireValidServerCertificates이(가) false인 경우) 이 매개변수를 true (으)로 설정하지 마십시오. MongoDB Go 드라이버는 tlsDisableCertificateRevocationCheck와(과) 비활성화된 인증서 확인을 결합하는 TLS 구성을 거부하므로, Ops Manager는 백업 에이전트의 연결을 끊을 수 있는 구성을 허용하는 대신 409 Conflict 오류로 이 조합을 거부합니다. 해지 확인을 비활성화하기 전에 인증서 확인을 활성화하십시오.

encryptionEnabled

부울

옵션

백업 구성에 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화 를 활성화할 때 syncSource 매개변수를 포함해야 합니다. 프로젝트 의 기존 백업의 경우 암호화 를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다.

MongoDB Ops Manager는 백업 커서를 사용하고 더 이상 헤드 데이터베이스를 사용하지 않습니다. 자세한 내용은 백업 디먼 서비스를 참조하세요.

백업 암호화에 대해 자세히 알아보려면 암호화된 백업 스냅샷을 참조하세요.

제외된 네임스페이스

문자열 배열

조건부

백업 에서 생략할 데이터베이스 및 컬렉션 이름 목록입니다. 각 문자열은 하나의 네임스페이스 나타냅니다. 네임스페이스는 다음 형식 중 하나를 사용합니다.

  • {데이터베이스}

  • {데이터베이스}.{컬렉션}.

MongoDB Ops Manager는 기능 호환성 버전 6.0 이상을 실행하는 MongoDB 데이터베이스를 백업할 때 이 매개변수를 무시합니다.

이 매개변수는 다음 조건을 충족해야 합니다.

  • MongoDB Ops Manager 이 매개변수 또는 embeddedNamespaces 둘 중 하나를 허용하지 않습니다.

  • Ops Manager에는 배열에 이미 있는 네임스페이스를 포함하여 제외된 네임스페이스의 새로운 전체 목록이 필요합니다.

    • 새 목록이 기존 배열에서 네임스페이스를 제거 하는 경우 syncSource 매개변수를 설정합니다.

      • 제외된 네임스페이스를 제거하려면 전체 재동기화가 필요합니다.

      • syncSource 매개변수가 없으면 요청이 실패합니다.

    • 새 목록이 기존 배열에만 추가 되는 경우 syncSource 를 설정하지 마세요.

includeNamespaces

문자열 배열

조건부

백업 에서 포함할 데이터베이스 및 컬렉션 이름의 목록입니다. 각 문자열은 하나의 네임스페이스 나타냅니다. 네임스페이스는 다음 형식 중 하나를 사용합니다.

  • {데이터베이스}

  • {데이터베이스}.{컬렉션}.

MongoDB Ops Manager는 기능 호환성 버전 6.0 이상을 실행하는 MongoDB 데이터베이스를 백업할 때 이 매개변수를 무시합니다.

이 매개변수는 다음 조건을 충족해야 합니다.

  • MongoDB Ops Manager 이 매개변수 또는 wiredNamespaces 둘 다 허용하지 않습니다.

  • Ops Manager에는 배열에 이미 있는 네임스페이스를 포함하여 포함된 네임스페이스의 새로운 전체 목록이 필요합니다.

    • 새 목록이 기존 배열의 네임스페이스를 추가하는 경우 syncSource 매개변수를 설정합니다.

      • 포함된 네임스페이스를 추가하려면 전체 재동기화가 필요합니다.

      • syncSource 매개변수가 없으면 요청이 실패합니다.

    • 새 목록이 기존 배열에서만 네임스페이스를 제거하는 경우 syncSource 를 설정하지 마세요.

비밀번호

문자열

조건부

동기화 소스 데이터베이스 에 연결할 때 사용할 비밀번호입니다. MongoDB Ops Manager 동기화 저장소 인스턴스에 클라이언트 인증이 필요한 경우 에 이 매개 변수가 필요합니다.mongod

preferenceMember

문자열

옵션

스냅샷을 생성하기 위해 사용자가 기본 복제본 세트 멤버로 지정하는 클러스터 멤버입니다. 콘솔 을 사용하여 기본 멤버를 설정할 수 있습니다. 하나의 백업 구성 엔드포인트 가져오기를 사용하여 기본 멤버 역할을 할 수 있는 사용 가능한 복제본 세트 멤버를 확인합니다.

프로비저닝

부울

조건부

Ops Manager가 백업을 저장하는 데 필요한 리소스를 프로비저닝했는지 여부를 나타내는 플래그입니다.

sslEnabled

부울

옵션

동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다.

statusName

문자열

옵션

백업 구성의 현재(또는 원하는) 상태입니다. Ops Manager는 다음을 허용합니다.

  • Inactive (비활성화)

  • 프로비저닝

  • STARTED

  • STOPPED

  • 종료 중

storageEngineName

문자열

옵션

백업에 사용되는 스토리지 엔진입니다. Ops Manager는 다음을 허용합니다.

  • MEMORY_MAPPED

  • FIRED_TIGER

syncSource

문자열

조건부

백업 데이터를 검색하는 mongod 인스턴스입니다. MongoDB Ops Manager는 특정 호스트 이름 또는 PRIMARY 및 SECONDARY 중 하나를 허용합니다.

"storageEngineName" : "WiRED_TIGER" 인 경우 Ops Manager에 이 매개 변수가 필요합니다.

사용자 이름

문자열

조건부

동기화 소스 데이터베이스 에 연결하는 데 사용할 사용자의 이름입니다. MongoDB Ops Manager 동기화 저장소 인스턴스에 클라이언트 인증이 필요한 경우 에 이 매개 변수가 필요합니다.mongod

Ops Manager가 관리 하지 않는 복제본 세트 또는 샤드 클러스터에 대한 백업 구성을 업데이트하는 경우 Ops Manager로 이 매개 변수를 전송하세요.

snapshotStore

객체

옵션

전환할 스냅샷 저장소 지정하는 객체입니다. 이 객체 에는 스냅샷 저장소 유형과 S3 버킷(S3 블록 저장소 )의 ID 포함되어 있습니다. 기존 스냅샷은 구성된 보존 정책에 따라 만료될 때까지 원래 저장 에 유지됩니다. 작업 페이지에서 S3호환 스냅샷 저장소간에 전환할 수도 있습니다.

snapshotStore.snapshotStoreType

문자열

조건부

스냅샷 저장소 유형을 식별하는 문자열입니다. 현재는 S3 버킷(S3 블록 저장소)만 지원됩니다. 값은 s3blockstore이어야 합니다. snapshotStore 객체 제공하는 경우 snapshotStoreType 및 snapshotStoreId 매개변수를 모두 지정해야 합니다.

snapshotStore.snapshotStoreId

문자열

조건부

전환할 S3 블록 저장소를 식별하는 string입니다. 새 스냅샷은 이 대상 S3 블록 저장소에 저장됩니다. 기존 스냅샷은 구성된 보존 정책에 따라 만료될 때까지 원래 저장소에 유지됩니다. snapshotStore 객체를 제공하는 경우 snapshotStoreType 및 snapshotStoreId 매개변수를 모두 지정해야 합니다.

응답

이름
유형
설명

authMechanismName

문자열

동기화 소스 데이터베이스에 연결할 때 사용할 인증 메커니즘의 이름입니다. 동기화 저장소가 인증을 사용하는 경우 Ops Manager가 이 매개 변수를 반환합니다.

clusterId

문자열

이 백업 구성이 적용되는 cluster의 고유 식별자입니다.

encryptionEnabled

부울

백업 구성에 대해 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화 를 활성화할 때 syncSource 필드 를 포함해야 합니다. 프로젝트 의 기존 백업의 경우 암호화 를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다.

MongoDB Ops Manager는 백업 커서를 사용하고 더 이상 헤드 데이터베이스를 사용하지 않습니다. 자세한 내용은 백업 디먼 서비스를 참조하세요.

백업 암호화에 대해 자세히 알아보려면 암호화된 백업 스냅샷을 참조하세요.

제외된 네임스페이스

문자열 배열

백업에서 생략할 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다.

includeNamespaces

문자열 배열

백업에 포함할 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다.

preferenceMember

문자열

스냅샷을 생성하기 위해 사용자가 기본 복제본 세트 멤버로 지정하는 클러스터 멤버입니다. 콘솔 을 사용하여 기본 멤버를 설정할 수 있습니다. 하나의 백업 구성 엔드포인트 가져오기를 사용하여 기본 멤버 역할을 할 수 있는 사용 가능한 복제본 세트 멤버를 확인합니다.

projectId

문자열

이 백업 구성을 소유하는 프로젝트의 고유 식별자입니다.

프로비저닝

부울

Ops Manager가 백업을 저장하는 데 필요한 리소스를 프로비저닝했는지 여부를 나타내는 플래그입니다. Ops Manager는 백업할 데이터의 양이 특정 임계값을 초과할 때 이 매개변수를 반환합니다.

sslEnabled

부울

동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다.

statusName

문자열

백업 구성의 현재 상태입니다.

storageEngineName

문자열

백업에 사용되는 storage engine입니다.

snapshotStore

객체

전환할 스냅샷 저장소 지정하는 객체입니다. 이 객체 에는 스냅샷 저장소 유형과 S3 버킷(S3 블록 저장소 )의 ID 포함되어 있습니다. 기존 스냅샷은 구성된 보존 정책에 따라 만료될 때까지 원래 저장 에 유지됩니다. 작업 페이지에서 S3호환 스냅샷 저장소간에 전환할 수도 있습니다.

snapshotStore.snapshotStoreType

문자열

스냅샷 저장소 유형을 식별하는 문자열입니다. 현재는 S3 버킷(S3 블록 저장소)만 지원됩니다. 값은 s3blockstore이어야 합니다. snapshotStore 객체 지정하는 경우 snapshotStoreType 및 snapshotStoreId 매개변수를 모두 지정해야 합니다.

snapshotStore.snapshotStoreId

문자열

전환할 S3 블록 저장소를 식별하는 string입니다. 새 스냅샷은 이 대상 S3 블록 저장소에 저장됩니다. 기존 스냅샷은 구성된 보존 정책에 따라 만료될 때까지 원래 저장소에 유지됩니다. snapshotStore 객체를 제공하는 경우 snapshotStoreType 및 snapshotStoreId 매개변수를 모두 지정해야 합니다.

요청 예시

curl --user "{publicKey}:{privateKey}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \     --data '       {         "statusName": "STARTED",         "storageEngineName": "WIRED_TIGER",         "syncSource": "primary"       }'

응답 예시

응답 헤더

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

{  "authMechanismName" : "NONE",  "clusterId" : "{clusterId}",  "encryptionEnabled" : false,  "excludedNamespaces" : [ ],  "groupId" : "{projectId}",  "links" : [ {    "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}",    "rel" : "self"   }, {    "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}",    "rel" : "http://mms.mongodb.com/cluster"  }, {    "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}",    "rel" : "http://mms.mongodb.com/group"  }, {    "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule",    "rel" : "http://mms.mongodb.com/snapshotSchedule"  } ],  "sslEnabled" : false,  "statusName" : "STARTED",  "storageEngineName" : "WIRED_TIGER"}
돌아가기
Get One
다음
배포 리전
이 페이지 평가하기

이 페이지의 내용