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진수 문자열입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
authMechanismName | 문자열 | 조건부 | 동기화 소스 데이터베이스에 연결하는 데 필요한 인증 메커니즘입니다. 동기화 저장소가 인증을 사용하는 경우 Ops Manager에 이 매개 변수가 필요합니다. Ops Manager는 다음을 허용합니다.
|
encryptionEnabled | 부울 | 옵션 | 백업 구성에 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화 를 활성화할 때 syncSource 매개변수를 포함해야 합니다. 프로젝트 의 기존 백업의 경우 암호화 를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다. FCV FCV 4.2 이상의 백업 암호화에 대한 자세한 내용은 암호화된 백업 스냅샷을 참조하세요. |
제외된 네임스페이스 | 문자열 배열 | 조건부 | 참고MongoDB Ops Manager 는 MongoDB FCV 4.0 이하 버전을 실행 백업 작업에 이 매개 변수를 허용합니다. 는 FCV 이상을 실행 하는 데이터베이스를MongoDB Ops Manager 백업할 때 이 매개 변수를 무시합니다.MongoDB 4.2 백업에서 생략 할 데이터베이스 및 컬렉션 이름 목록입니다. 각 string 은 하나의 네임스페이스를 나타냅니다. 네임스페이스는 {database} 또는 {database}.{collection} 형식을 사용합니다. 이 매개변수는 다음 조건을 충족해야 합니다.
|
includeNamespaces | 문자열 배열 | 조건부 | 참고MongoDB Ops Manager 는 MongoDB FCV 4.0 이하 버전을 실행 백업 작업에 이 매개 변수를 허용합니다. 는 FCV 이상을 실행 하는 데이터베이스를MongoDB Ops Manager 백업할 때 이 매개 변수를 무시합니다.MongoDB 4.2 백업에 포함 할 데이터베이스 및 컬렉션 이름 목록입니다. 각 string 은 하나의 네임스페이스를 나타냅니다. 네임스페이스는 {database} 또는 {database}.{collection} 형식을 사용합니다. 이 매개변수는 다음 조건을 충족해야 합니다.
|
비밀번호 | 문자열 | 조건부 | 동기화 소스 데이터베이스 에 연결할 때 사용할 비밀번호입니다. MongoDB Ops Manager 동기화 저장소 인스턴스에 클라이언트 인증이 필요한 경우 에 이 매개 변수가 필요합니다. mongod |
preferenceMember | 문자열 | 옵션 | 스냅샷을 생성하기 위해 사용자가 기본 복제본 세트 멤버로 지정하는 클러스터 멤버입니다. 콘솔 을 사용하여 기본 멤버를 설정할 수 있습니다. 하나의 백업 구성 엔드포인트 가져오기를 사용하여 기본 멤버 역할을 할 수 있는 사용 가능한 복제본 세트 멤버를 확인합니다. |
프로비저닝 | 부울 | 조건부 | Ops Manager가 백업을 저장하는 데 필요한 리소스를 프로비저닝했는지 여부를 나타내는 플래그입니다. |
sslEnabled | 부울 | 옵션 | 동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다. |
statusName | 문자열 | 옵션 | 백업 구성의 현재(또는 원하는) 상태입니다. Ops Manager는 다음을 허용합니다.
|
storageEngineName | 문자열 | 옵션 | 백업에 사용되는 스토리지 엔진입니다. Ops Manager는 다음을 허용합니다.
|
syncSource | 문자열 | 조건부 | 백업 데이터를 검색하는 "storageEngineName" : "WiRED_TIGER" 인 경우 Ops Manager에 이 매개 변수가 필요합니다. |
사용자 이름 | 문자열 | 조건부 | 동기화 소스 데이터베이스 에 연결하는 데 사용할 사용자의 이름입니다. MongoDB Ops Manager 동기화 저장소 인스턴스에 클라이언트 인증이 필요한 경우 에 이 매개 변수가 필요합니다. Ops Manager가 관리 하지 않는 복제본 세트 또는 샤드 클러스터에 대한 백업 구성을 업데이트하는 경우 Ops Manager로 이 매개 변수를 전송하세요. |
응답
이름 | 유형 | 설명 |
---|---|---|
authMechanismName | 문자열 | 동기화 소스 데이터베이스에 연결할 때 사용할 인증 메커니즘의 이름입니다. 동기화 저장소가 인증을 사용하는 경우 Ops Manager가 이 매개 변수를 반환합니다. |
clusterId | 문자열 | 이 백업 구성이 적용되는 cluster의 고유 식별자입니다. |
encryptionEnabled | 부울 | 백업 구성에 대해 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화 를 활성화할 때 syncSource 필드 를 포함해야 합니다. 프로젝트 의 기존 백업의 경우 암호화 를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다. FCV FCV 4.2 이상의 백업 암호화에 대한 자세한 내용은 암호화된 백업 스냅샷을 참조하세요. |
제외된 네임스페이스 | 문자열 배열 | 백업에서 생략할 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다. |
includeNamespaces | 문자열 배열 | 백업에 포함할 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스입니다. |
preferenceMember | 문자열 | 스냅샷을 생성하기 위해 사용자가 기본 복제본 세트 멤버로 지정하는 클러스터 멤버입니다. 콘솔 을 사용하여 기본 멤버를 설정할 수 있습니다. 하나의 백업 구성 엔드포인트 가져오기를 사용하여 기본 멤버 역할을 할 수 있는 사용 가능한 복제본 세트 멤버를 확인합니다. |
projectId | 문자열 | 이 백업 구성을 소유하는 프로젝트의 고유 식별자입니다. |
프로비저닝 | 부울 | Ops Manager가 백업을 저장하는 데 필요한 리소스를 프로비저닝했는지 여부를 나타내는 플래그입니다. Ops Manager는 백업할 데이터의 양이 특정 임계값을 초과할 때 이 매개변수를 반환합니다. |
sslEnabled | 부울 | 동기화 소스 데이터베이스에 대해 TLS 를 사용하도록 설정했는지 여부를 나타내는 플래그입니다. |
statusName | 문자열 | 백업 구성의 현재 상태입니다. |
storageEngineName | 문자열 | 백업에 사용되는 storage engine입니다. |
요청 예시
1 curl --user "{publicKey}:{privateKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ 5 --data ' 6 { 7 "statusName": "STARTED", 8 "storageEngineName": "WIRED_TIGER", 9 "syncSource": "primary" 10 }'
각 스냅샷이 시작되면 Ops Manager는 스냅샷을 실행할 복제본 세트 구성원을 선택합니다. 자동으로 선택된 이 멤버는 복제본 세트에 미치는 성능 영향이 가장 적어야 합니다. 기본 선택 항목을 재정의할 수 있습니다.
중요
가능하면 default selection 를 사용하세요. 이 선택은 백업 가용성을 보장합니다.
다음 요청 은 기본 멤버를 설정합니다.
1 curl --user "{publicKey}:{privateKey}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}" \ 5 --data ' 6 { 7 "preferredMember":"{HOSTNAME}:{PORT}" 8 }'
응답 예시
응답 헤더
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
응답 본문
1 { 2 "authMechanismName" : "NONE", 3 "clusterId" : "{clusterId}", 4 "encryptionEnabled" : false, 5 "excludedNamespaces" : [ ], 6 "groupId" : "{projectId}", 7 "links" : [ { 8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", 9 "rel" : "self" 10 }, { 11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", 12 "rel" : "http://mms.mongodb.com/cluster" 13 }, { 14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", 15 "rel" : "http://mms.mongodb.com/group" 16 }, { 17 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule", 18 "rel" : "http://mms.mongodb.com/snapshotSchedule" 19 } ], 20 "sslEnabled" : false, 21 "statusName" : "STARTED", 22 "storageEngineName" : "WIRED_TIGER" 23 }
각 스냅샷이 시작되면 Ops Manager는 스냅샷을 실행할 복제본 세트 구성원을 선택합니다. 자동으로 선택된 이 멤버는 복제본 세트에 미치는 성능 영향이 가장 적어야 합니다. 기본 선택 항목을 재정의할 수 있습니다.
중요
가능하면 default selection 을(를) 사용하세요. 이렇게 하면 백업 가용성이 보장됩니다.
다음 응답에는 기본 멤버가 포함되어 있습니다.
1 { 2 "authMechanismName" : "NONE", 3 "clusterId" : "{clusterId}", 4 "encryptionEnabled" : false, 5 "excludedNamespaces" : [ ], 6 "groupId" : "{projectId}", 7 "links" : [ { 8 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}", 9 "rel" : "self" 10 }, { 11 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/clusters/{clusterId}", 12 "rel" : "http://mms.mongodb.com/cluster" 13 }, { 14 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}", 15 "rel" : "http://mms.mongodb.com/group" 16 }, { 17 "href" : "http://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{projectId}/backupConfigs/{clusterId}/snapshotSchedule", 18 "rel" : "http://mms.mongodb.com/snapshotSchedule" 19 } ], 20 "sslEnabled" : false, 21 "statusName" : "STARTED", 22 "storageEngineName" : "WIRED_TIGER", 23 "preferredMember":"{HOSTNAME}:{PORT}" 24 }