모든 동기화 저장소 구성 가져오기
모든 동기화 저장소의 구성을 검색합니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /sync/mongoConfigs
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. |
|
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 옵션 |
| |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 |
|
AssignableOnly | 부울 | 이 동기화 저장소에 새 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다. |
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 동기화 저장소입니다.
이름 | 유형 | 설명 |
---|---|---|
AssignmentEnabled | 부울 | 이 동기화 저장소에 백업 작업을 할당할 수 있는지 여부를 나타내는 플래그입니다. |
암호화된 자격증명 | 부울 | 이 동기화 저장소의 사용자 이름 및 비밀번호가 credentialstool을 사용하여 암호화되었는지 여부를 나타내는 플래그입니다. |
id | 문자열 | 이 동기화 저장소에 레이블을 지정하는 고유 이름입니다. |
labels | 문자열 배열 | 가 어떤 동기화 저장소 에 할당할 수 있는 백업 작업 을 관리 하기 위한 태그 배열입니다.MongoDB Ops Manager |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
maxCapacityGB | 숫자 | 이 동기화 저장소가 저장할 수 있는 최대 데이터 양(GB)입니다. |
uri | 문자열 | 이 동기화 저장소에 액세스하는 데 사용할 수 있는 |
ssl | 부울 | 이 동기화 저장소가 TLS 를 사용하여 암호화된 연결만 허용하는지 여부를 나타내는 플래그입니다. |
usedSize | 숫자 | 기존 백업이 사용하는 백업 용량의 양( MB )입니다. |
쓰기 고려 | 문자열 | 이 동기화 저장소에 사용되는 쓰기 고려 (write concern)입니다. 이 옵션에 허용되는 값은 다음과 같습니다.
MongoDB 의 쓰기 (write) 승인 수준에 학습 보려면 쓰기 고려를 참조하세요 . |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true'
응답 예시
응답 헤더
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}
응답 본문
{ "links" : [ { "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "assignmentEnabled" : true, "encryptedCredentials" : false, "id" : "{CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/sync/mongoConfigs/{SYNCSTORE-ID}", "rel" : "self" }], "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" } ], "totalCount" : 1 }