Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ /

루트

이 페이지의 내용

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

루트 리소스는 Cloud Manager API의 시작점입니다. 여기에서 links 를 이동하여 다른 모든 API 리소스에 액세스할 수 있습니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

GET /

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

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

이름
유형
필요성
설명
기본값
pageNum
숫자
옵션
결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.
1
itemsPerPage
숫자
옵션
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
옵션
응답 본문을 프리티프린트 에 넣어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope : true를 설정합니다.

결과 목록을 반환하는 엔드포인트의 경우 content 객체는 엔벨로프입니다. Cloud Manager가 status 필드를 응답 본문에 추가합니다.

false
backupJobsEnabledOnly
부울
옵션
데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.
true

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

응답에는 다음이 포함됩니다.

이름
유형
설명
앱 이름
문자열
MongoDB Cloud
빌드
문자열
Cloud Manager에 대한 GitHub 커밋에 해당하는 SHA입니다.
링크
객체 배열

하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 links 배열에는 self 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.

스로틀링
부울
이 필드는 더 이상 사용되지 않으며 값은 false 입니다.
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0"
{
"appName" : "MongoDB Cloud",
"build" : "ec8b09b880be314981caa9d8fbefc3280056522e",
"links" : [
],
"throttling" : false
}

돌아가기

Cloud Manager 관리 API 리소스