문서 메뉴
문서 홈
/
MongoDB Cloud Manager
/
API
/
Cloud Manager 관리 API 리소스
/
조직 및 팀
/
조직

조직의 모든 프로젝트 가져오기

이 페이지의 내용

  • 리소스
  • 요청 매개변수
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 문서
  • results embeddedDocument
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

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

리소스

GET /orgs/{ORG-ID}/groups

요청 매개변수

요청 경로 매개변수

경로 요소
유형
설명
ORG-ID
필수 사항입니다.
정보를 검색하려는 조직 의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름
유형
설명
기본값
pageNum
integer
페이지 번호(1 기준).
1
itemsPerPage
integer
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
false
envelope
부울
false
name
문자열

반환된 목록을 필터링하는 데 사용할 프로젝트의 사람이 읽을 수 있는 레이블입니다. 조직 내에서 지정된 name 접두사가 붙은 프로젝트에 대해 대소문자를 구분하지 않는 검색을 수행합니다.

예제

name 쿼리 매개변수를 project1 으로 지정하면 Cloud Manager는 project1 라는 프로젝트를 반환하지만, project123 프로젝트는 반환하지 않습니다.

none

요청 본문 매개변수

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

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열 및 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 프로젝트입니다.

이름
유형
설명
activeAgentCount
integer
프로젝트의 활성 모니터링, 자동화 및 백업 수입니다.
hostCounts
문서
클러스터의 호스트 유형과 각 호스트 유형 수를 설명합니다.
hostCounts.arbiter
integer
클러스터의 중재자 호스트 수입니다.
hostCounts.config
integer
cluster의 샤딩된 cluster 구성 서버 호스트 수입니다.
hostCounts.mongos
integer
클러스터에 있는 mongos 호스트의 수입니다.
hostCounts.primary
integer
클러스터의 프라이머리 호스트 수입니다.
hostCounts.secondary
integer
클러스터의 세컨더리 호스트 수입니다.
id
문자열
프로젝트의 고유 식별자입니다.
링크
객체 배열

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

이름
문자열
cluster의 이름입니다.
orgId
문자열
프로젝트의 상위 조직에 대한 고유 식별자입니다.
publicApiEnabled
부울
클러스터에 대한 API 액세스 상태입니다.
replicaSetCount
integer
cluster에 있는 복제본 세트의 수입니다.
shardCount
integer
cluster의 샤드 수입니다.

요청 예시

curl --user "{username:apiKey}" \
     --include \
     --header "Content-Type: application/json" \
     --digest GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/groups"

응답 예시

응답 헤더

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}

응답 본문

{
  "links": [{
  }],
  "results": [{
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "mongos": 0,
      "primary": 1,
      "secondary": 2
      },
    "id": "{PROJECT-ID}",
    "links": [{
    }],
    "name": "Production Cluster",
    "orgId": "{ORG-ID}",
    "publicApiEnabled": true,
    "replicaSetCount": 1,
    "shardCount": 0
  },
  {
    "activeAgentCount": 0,
    "hostCounts": {
      "arbiter": 0,
      "config": 0,
      "mongos": 0,
      "primary": 1,
      "secondary": 2
    },
    "id": "{PROJECT-ID}",
    "lastActiveAgent": "2017-10-26T02:39:59Z",
    "links": [{
    }],
    "name": "Staging Cluster",
    "orgId": "{ORG-ID}",
    "publicApiEnabled": true,
    "replicaSetCount": 1,
    "shardCount": 0
    }
  ],
  "totalCount": 2
}

돌아가기

1개의 조직 가져오기

다음

모든 조직 사용자 가져오기

이 페이지의 내용