1개의 프로젝트에 대해 모든 백업 구성 가져오기

이 페이지의 내용

Resource

요청 매개변수
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

MongoDB Ops Manager v6.0 는 2025 1월에 EOL됩니다. 가능한 한 빨리 상위 MongoDB Ops Manager 버전으로 업그레이드하세요.

참고

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

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

Resource

GET /groups/{PROJECT-ID}/backupConfigs

요청 매개변수

요청 경로 매개변수

이름	유형	필요성	설명
프로젝트 ID	문자열	필수 사항	백업 구성이 적용되는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

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

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true`를 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `results` 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 `status` 필드를 추가합니다.	`false`
backupJobsEnabledOnly	부울	옵션	데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. `backupJobsEnabled` 플래그가 `false` 로 설정된 daemon 구성을 포함하려면 이 값을 `false` 로 설정합니다.	`true`

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이름	유형	설명
groupId	문자열	이 백업 구성을 소유하는 프로젝트를 식별하는 고유한 24자리 16진수 문자열입니다.
clusterId	문자열	백업 구성을 찾으려는 cluster를 식별하는 고유한 24자리 16진수 문자열입니다.
statusName	문자열	백업 구성의 현재(또는 원하는) 상태입니다. 가능한 값은 다음과 같습니다. `INACTIVE` `PROVISIONING` `STARTED` `STOPPED` `TERMINATING`
storageEngineName	문자열	백업에 사용되는 스토리지 엔진입니다. 가능한 값은 다음과 같습니다. `MEMORY_MAPPED` `WIRED_TIGER`

encryptionEnabled	부울	백업 구성에 암호화 가 활성화되어 있는지 여부를 나타내는 플래그입니다. 백업 구성에 대한 암호화 를 활성화할 때 `syncSource` 필드 를 포함해야 합니다. 프로젝트 의 기존 백업의 경우 암호화 를 활성화하려면 백업의 헤드 데이터베이스를 다시 만들기 위한 초기 동기화 가 필요합니다. FCV `4.2` 그리고 나중에 헤드 데이터베이스 대신 백업 커서 를 사용할 수 있습니다. 자세한 내용은 백업 디먼 서비스를 참조하세요. FCV 4.2 이상의 백업 암호화에 대한 자세한 내용은 암호화된 백업 스냅샷을 참조하세요.

sslEnabled	부울	동기화 소스 데이터베이스에 대해 TLS 를 사용할지 여부를 나타내는 플래그입니다.
제외된 네임스페이스	문자열 배열	백업에서 생략할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 `<database>` 또는 `<database>.<collection>` 형식의 네임스페이스입니다. 이 필드가 있는 경우 `includedNamespaces` 필드는 있을 수 없습니다. 이미 나열된 네임스페이스를 포함하여 제외된 네임스페이스의 새로운 전체 목록을 보내야 합니다. 새 목록이 이전 목록의 네임스페이스를 제거하는 경우 제외된 네임스페이스를 제거하면 전체 재동기화가 필요하므로 `syncSource` 필드도 설정해야 합니다. `syncSource` 필드가 없으면 요청이 실패합니다. 새 목록이 이전 목록에만 추가되는 경우 `syncSource` 을 설정할 필요가 없습니다.
includeNamespaces	문자열 배열	백업에 포함할 데이터베이스 이름 및 collection 이름 목록입니다. 각 문자열은 `<database>` 또는 `<database>.<collection>` 형식의 네임스페이스입니다. 이 배열에 포함 되지 않은 네임스페이스 는 백업되지 않습니다. 이 필드가 있는 경우 `excludedNamespaces` 필드는 있을 수 없습니다. 이미 나열된 네임스페이스를 포함하여 포함된 네임스페이스의 새로운 전체 목록을 보내야 합니다. 새 목록이 이전 목록에 네임스페이스를 추가하는 경우 포함된 네임스페이스를 추가하면 전체 재동기화가 필요하므로 `syncSource` 필드도 설정해야 합니다. `syncSource` 필드가 없으면 요청이 실패합니다. 새 목록이 이전 목록의 네임스페이스만 제거하는 경우 `syncSource` 을 설정할 필요가 없습니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs"

응답 예시

응답 헤더

HTTP/1.1 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

HTTP/1.1 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   "totalCount" : 3,
3   "results" : [ {
4     "groupId" : "{PROJECT-ID}",
5     "clusterId" : "{CLUSTER-ID1}",
6     "statusName" : "STARTED",
7     "storageEngineName" : "WIRED_TIGER",
8     "sslEnabled" : false,
9     "excludedNamespaces" : [ ],
10     "includedNamespaces" : [ ],
11     "links" : [ ]
12   }, {
13     "groupId" : "{PROJECT-ID}",
14     "clusterId" : "{CLUSTER-ID2}",
15     "statusName" : "STARTED",
16     "storageEngineName" : "MEMORY_MAPPED",
17     "sslEnabled" : false,
18     "excludedNamespaces" : [ ],
19     "includedNamespaces" : [ ],
20     "links" : [ ]
21   }, {
22     "groupId" : "{PROJECT-ID}",
23     "clusterId" : "{CLUSTER-ID3}",
24     "statusName" : "STOPPED",
25     "storageEngineName" : "WIRED_TIGER",
26     "sslEnabled" : false,
27     "excludedNamespaces" : [ ],
28     "includedNamespaces" : [ ],
29     "links" : [ ]
30   } ],
31   "links" : [ ]
32 }

돌아가기

백업 구성

1개의 프로젝트에서 1개의 백업 구성 가져오기

1	{
2	"totalCount" : 3,
3	"results" : [ {
4	"groupId" : "{PROJECT-ID}",
5	"clusterId" : "{CLUSTER-ID1}",
6	"statusName" : "STARTED",
7	"storageEngineName" : "WIRED_TIGER",
8	"sslEnabled" : false,
9	"excludedNamespaces" : [ ],
10	"includedNamespaces" : [ ],
11	"links" : [ ]
12	}, {
13	"groupId" : "{PROJECT-ID}",
14	"clusterId" : "{CLUSTER-ID2}",
15	"statusName" : "STARTED",
16	"storageEngineName" : "MEMORY_MAPPED",
17	"sslEnabled" : false,
18	"excludedNamespaces" : [ ],
19	"includedNamespaces" : [ ],
20	"links" : [ ]
21	}, {
22	"groupId" : "{PROJECT-ID}",
23	"clusterId" : "{CLUSTER-ID3}",
24	"statusName" : "STOPPED",
25	"storageEngineName" : "WIRED_TIGER",
26	"sslEnabled" : false,
27	"excludedNamespaces" : [ ],
28	"includedNamespaces" : [ ],
29	"links" : [ ]
30	} ],
31	"links" : [ ]
32	}