모든 배포 리전 가져오기

이 페이지의 내용

Resource

요청 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
요청 본문
응답 본문

참고

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

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

Resource

GET /admin/backup/backupDeployments

요청 매개변수

요청 쿼리 매개변수

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

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

요청 본문 매개변수

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

응답

이름	유형	설명
`assignmentEnabled`	부울	백업 리소스에 배포 리전 을 할당할 수 있는지 여부를 나타내는 플래그입니다.
`bqProxyEndpoint`	문자열	MongoDB Ops Manager 쿼리 가능 백업 요청을 처리하는 인스턴스 입니다. 값의 형식은 `domain:port` 입니다. 예를 예시`localhost:8080` 입니다.
`deploymentDescription`	문자열	배포 리전의 목적을 설명하는 string 입니다.
`id`	문자열	구성에서 이 배포서버 리전 을 참조하는 고유 식별자입니다.
`ingestionEndpoint`	문자열	MongoDB Ops Manager 백업 에이전트 oplog 가 스냅샷 또는 데이터를 기록하는 인스턴스 입니다. 값은 유효한 URL (예: `http://www.mongodb.com` 입니다. HTTP 와 HTTPS 를 모두 지원합니다.
`links`	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`restoreEndpoint`	문자열	복원 요청을 처리하는 MongoDB Ops Manager 인스턴스 입니다.

요청 예시

요청 본문

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

응답 본문

1 {
2   "links" : [ ],
3   "results" : [ {
4     "assignmentEnabled" : true,
5     "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6     "deploymentDescription" : "Eastern US",
7     "id" : "NY_NJ",
8     "ingestionEndpoint" : "https://api-backup.mongodb.com",
9     "links" : [ ],
10     "restoreEndpoint" : "https://api-backup.mongodb.com"
11   } ],
12   "totalCount" : 1
13 }

돌아가기

배포 리전

1개의 배포 리전 가져오기

1	{
2	"links" : [ ],
3	"results" : [ {
4	"assignmentEnabled" : true,
5	"bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6	"deploymentDescription" : "Eastern US",
7	"id" : "NY_NJ",
8	"ingestionEndpoint" : "https://api-backup.mongodb.com",
9	"links" : [ ],
10	"restoreEndpoint" : "https://api-backup.mongodb.com"
11	} ],
12	"totalCount" : 1
13	}