1개의 샤드에 배포 리전 할당
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
요청 매개변수
요청 경로 매개변수
Parameter | 유형 | 필요성 | 설명 |
---|---|---|---|
프로젝트 ID | 문자열 | 필수 사항 | 찾으려는 백업 구성이 있는 cluster를 보유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. |
CLUSTER-ID | 문자열 | 필수 사항 | 백업 구성을 찾으려는 cluster를 식별하는 고유한 24자리 16진수 문자열입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
응답
이름 | 유형 | 설명 |
---|---|---|
authMechanismName | 문자열 | 동기화 소스 데이터베이스 에 연결하는 데 필요한 인증 메커니즘입니다. 동기화 저장소 가 인증 을 사용하는 경우 MongoDB Ops Manager 에 이 매개 변수가 필요합니다. MongoDB Ops Manager 는 다음 중 하나를 반환합니다.
|
clusterId | 문자열 | 백업 으로 구성된 클러스터 를 식별하는 고유한 24-16진수 string 입니다. |
encryptionEnabled | 부울 | 백업 구성에 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. |
excludedNamespaces | 문자열 배열 | 백업 에서 생략된 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스 를 지정합니다. |
groupId | 문자열 | 이 백업 구성을 소유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다. |
includedNamespaces | 문자열 배열 | 백업 에 포함된 데이터베이스 이름 및 컬렉션 이름 목록입니다. 각 string 은 {database} 또는 {database}.{collection} 형식의 네임스페이스 를 지정합니다. 이 배열 에 나열되지 않은 네임스페이스 는 백업할 수 없습니다. |
links | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
multiRegionBackupEnabled | 부울 | 클러스터 에 대해 멀티 리전 백업 이 활성화되어 있는지 여부를 나타내는 플래그입니다. |
multiRegionMisconfigured | 부울 | 멀티 리전 백업 이 활성화된 경우
|
preferredMember | 문자열 | 백업에 대한 기본 멤버로 수동으로 지정된 cluster 멤버. UI 또는 API를 사용하여 기본 멤버가 설정된 경우 멤버 요청에 대해서만 표시됩니다. |
sslEnabled | 부울 | 동기화 소스 데이터베이스에 대해 TLS 를 사용할지 여부를 나타내는 플래그입니다. |
statusName | 문자열 | 백업 구성의 현재(또는 원하는) 상태입니다. 가능한 값은 다음과 같습니다.
|
storageEngineName | 문자열 | 백업에 사용되는 스토리지 엔진입니다. 가능한 값은 다음과 같습니다.
|
요청 예시
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments/?pretty=true" --data ' { "multiRegionBackupEnabled" : true, "deploymentConfigs": [ {"rsId":"myShard_2", "deploymentId":"NY_NJ"}, ] }'
응답 예시
응답 헤더
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}
응답 본문
{ "authMechanismName" : "NONE", "clusterId" : "{CLUSTER-ID}", "encryptionEnabled" : false, "excludedNamespaces" : [ ], "groupId" : "{PROJECT-ID}", "links" : [ ], "multiRegionBackupEnabled" : true, "multiRegionMisconfigured" : false, "sslEnabled" : false, "statusName" : "STARTED", "storageEngineName" : "WIRED_TIGER" }