참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/byName/{GROUP-NAME}
요청 매개변수
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
GROUP-NAME | 문자열 | (필수 사항) 프로젝트의 이름입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
activeAgentCount | integer | Cloud Manager 에 일반 핑을 전송하는 활성 에이전트의 수입니다. 이 값은 약 24 시간마다 새로 고쳐지고 캐시됩니다. 새 에이전트를 시작하거나 기존 에이전트를 중지하는 경우 |
hostCounts | 객체 | 유형별 총 호스트 수입니다. 포함된 필드는 설명이 필요 없습니다. |
id | 문자열 | 그룹 의 고유 식별자입니다. |
lastActiveAgent | 문자열 | Cloud Manager가 프로젝트의 총 |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
이름 | 문자열 | 프로젝트의 표시 이름입니다. |
orgId | 문자열 | 프로젝트가 속한 조직의 고유 식별자입니다. |
publicApiEnabled | 부울 | 이 프로젝트에 대해 API 가 활성화되어 있음을 나타내는 플래그입니다. 이 필드는 항상 |
replicaSetCount | integer | 이 프로젝트의 총 복제본 세트 수입니다. |
shardCount | integer | 이 프로젝트의 총 샤드 수입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/{GROUP-NAME}?pretty=true"
중요
일부 문자는 URL에 사용할 수 없습니다. 이를 예약 문자 라고 합니다. 에 공백과 {GROUP-NAME} 같은 예약 문자가 포함된 경우 해당 문자를 백분율 인코딩으로 바꿔야 합니다.
예를 예시 다음과 같이 요청 하는 대신 (컬을 통해) 다음을 수행합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Project?pretty=true"
다음과 같이 요청합니다(컬을 통해).
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/byName/My%20Group?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}
응답 본문
{ "activeAgentCount": 1, "agentApiKey": "{AGENT-API-KEY}", "hostCounts": { "arbiter": 2, "config": 1, "primary": 4, "secondary": 8, "mongos": 2 }, "id": "{PROJECT-ID}", "lastActiveAgent": ISODate("2016-08-05T07:23:34Z"), "links" : [], "name": "My Project", "orgId" : "111111111cccccf38dc78bdf", "publicApiEnabled": true, "replicaSetCount": 3, "shardCount": 2, }