참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID} 은 그룹 ID와 동일합니다. 기존 그룹의 경우 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 애기할 때 더욱 친숙한 용어인 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups요청 매개변수
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. |
|
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 옵션 | 응답 본문이 예쁜 인쇄 형식이어야 하는지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 |
|
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. |
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 프로젝트입니다.
이름 | 유형 | 설명 |
|---|---|---|
activeAgentCount | integer | Cloud Manager 에 일반 핑을 전송하는 활성 에이전트의 수입니다. 이 값은 약 24 시간마다 새로 고쳐지고 캐시됩니다. 새 에이전트를 시작하거나 기존 에이전트를 중지하는 경우 |
hostCounts | 객체 | 유형별 총 호스트 수입니다. 포함된 필드는 설명이 필요 없습니다. |
id | 문자열 | 그룹 의 고유 식별자입니다. |
lastActiveAgent | 문자열 | Cloud Manager가 프로젝트의 총 |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
이름 | 문자열 | 프로젝트의 표시 이름입니다. |
orgId | 문자열 | 프로젝트가 속한 조직의 고유 식별자입니다. |
publicApiEnabled | 부울 | 이 프로젝트에 대해 API 가 활성화되어 있음을 나타내는 플래그입니다. 이것은 항상 |
replicaSetCount | integer | 이 프로젝트의 총 복제본 세트 수입니다. |
shardCount | integer | 이 프로젝트의 총 샤드 수입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true"응답 예시
응답 헤더
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
{ "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" }, { "href": "https://cloud.mongodb.com/api/public/v1.0/groups?pretty=true&itemsPerPage=100&pageNum=2", "rel": "next" }], "results": [{ "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 0, "secondary": 0 }, "id": "56a10a80e4b0fd3b9a9bb0c2", "lastActiveAgent": "2016-03-09T18:19:37Z", "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "self" }], "name": "012i3091203jioawjioej", "orgId": "5980cfdf0b6d97029d82f86e", "publicApiEnabled": true, "replicaSetCount": 0, "shardCount": 0, "tags": [] }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 0, "secondary": 0 }, "id": "56aa691ce4b0a0e8c4be51f7", "lastActiveAgent": "2016-01-29T19:02:56Z", "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "self" }], "name": "1454008603036", "orgId": "5980d0040b6d97029d831798", "publicApiEnabled": true, "replicaSetCount": 0, "shardCount": 0, "tags": [] }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 0, "secondary": 0 }, "id": "56aa6dfde4b0fe328eee82ad", "lastActiveAgent": "2016-01-29T20:34:28Z", "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "self" }], "name": "1454009852809", "orgId": "5980d0040b6d97029d831799", "publicApiEnabled": true, "replicaSetCount": 0, "shardCount": 0, "tags": [] }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 0, "secondary": 0 }, "id": "56aa8421e4b0d04c1c54df99", "lastActiveAgent": "2016-01-29T21:36:10Z", "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "self" }], "name": "1454015520776", "orgId": "5980d0040b6d97029d83179a", "publicApiEnabled": true, "replicaSetCount": 0, "shardCount": 0, "tags": [] }, { "activeAgentCount": 0, "hostCounts": { "arbiter": 0, "config": 0, "mongos": 0, "primary": 0, "secondary": 0 }, "id": "56aa85f9e4b0d04c1c54e347", "lastActiveAgent": "2016-01-29T21:36:10Z", "links": [{ "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}", "rel": "self" }], "name": "1454015992252", "orgId": "5980d0040b6d97029d83179b", "publicApiEnabled": true, "replicaSetCount": 0, "shardCount": 0, "tags": [] }], "totalCount": 5}