1개의 프로젝트에서 모든 호스트 가져오기
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
프로젝트의 모든 MongoDB 호스트를 가져옵니다. 지정된 클러스터에 속한 호스트만 가져오려면 CLUSTER-ID 쿼리 매개변수를 사용합니다. 응답은 호스트를 HOSTNAME:PORT 를 기준으로 알파벳순으로 정렬합니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts
GET /groups/{PROJECT-ID}/hosts?clusterId={CLUSTER-ID}
요청 경로 매개변수
Parameter | 유형 | 필요성 | 설명 |
|---|---|---|---|
프로젝트 ID | 문자열 | 필수 사항 | 이 MongoDB 호스트를 소유한 프로젝트의 고유 식별자입니다. |
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. |
|
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 옵션 |
| |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 |
|
Parameter | 유형 | 필요성 | 설명 |
|---|---|---|---|
CLUSTER-ID | 문자열 | 필수 사항 | 이 MongoDB 프로세스가 속한 cluster의 고유 식별자입니다. |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 호스트입니다.
이름 | 유형 | 설명 |
|---|---|---|
별칭 | 문자열 배열 | Ops Manager가 MongoDB 프로세스에 대해 검색한 대체 호스트 이름 및 포트 조합의 배열입니다. 이러한 조합에는 호스트 이름, FQDN , IPv4 주소 및 IPv6 주소가 포함될 수 있습니다. |
alertsEnabled | 부울 |
|
authMechanismName | 문자열 | 이 MongoDB 프로세스에 연결하는 데 사용되는 인증 메커니즘입니다. 그러면 다음 값 중 하나만 표시됩니다.
|
clusterId | 문자열 | MongoDB 프로세스가 속한 cluster의 고유 식별자입니다. |
생성됨 | 날짜 | Ops Manager가 이 MongoDB 프로세스를 만들거나 처음 발견한 날짜입니다. |
groupId | 문자열 | 이 호스트를 소유한 그룹 의 고유 식별자입니다. |
hasStartupWarnings | 부울 |
|
숨김 | 부울 |
|
숨겨진 세컨더리 | 부울 |
|
hostEnabled | 부울 |
|
호스트 이름 | 문자열 | Ops Manager가 가장 잘 결정할 수 있는 기본 호스트 이름입니다. 이는 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소일 수 있습니다. |
id | 문자열 | 고유 식별자입니다. |
ipAddress | 문자열 | 이 MongoDB 프로세스의 |
journalingEnabled | 부울 |
|
lastDataSizeBytes | 숫자 | 인덱스를 제외한 디스크에 있는 호스트 데이터베이스의 압축되지 않은 크기(바이트)입니다. 은(는) 로컬 데이터베이스의 |
lastIndexSizeBytes | 숫자 | 디스크에 있는 호스트 데이터베이스 인덱스의 압축되지 않은 크기(바이트)입니다. 이 숫자에는 로컬 데이터베이스의 인덱스 크기가 포함 되지 않습니다 . |
lastPing | 날짜 | ISO 8601 의 타임스탬프 이 MongoDB 프로세스에 대한 마지막 핑이 수신된 날짜 및 시간 형식(UTC )입니다. |
lastRestart | 날짜 | ISO 8601 의 타임스탬프 이 프로세스가 마지막으로 다시 시작된 날짜 및 시간 형식(UTC )입니다. MongoDB 프로세스를 다시 시작한 적이 없는 경우 |
링크 | 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크가 포함된 배열입니다. URL 간의 관계는 웹 링크 사양 에 설명되어 있습니다. . 최소한 |
logsEnabled | 부울 |
|
LowUlimit | 부울 |
|
포트 | 숫자 | MongoDB 프로세스가 수신 대기하는 포트입니다. |
ProfilerEnabled | 부울 |
|
복제본 세트 이름 | 문자열 | 이 프로세스가 속한 복제본 세트의 이름입니다. 이 프로세스가 복제본 세트의 일부인 경우에만 표시됩니다. |
replicaStateName | 문자열 | 복제본 세트 내 이 MongoDB 프로세스의 현재 상태입니다. 이 프로세스가 복제본 세트의 일부인 경우에만 표시됩니다. 가능한 값은 복제본 세트 멤버 상태 를 참조하세요. |
shardName | 문자열 | 이 프로세스가 속한 샤드의 이름입니다. 프로세스가 샤드 cluster의 일부인 경우에만 표시됩니다. |
secondaryDelaySecs | 숫자 | 이 복제본 세트 멤버의 데이터가 프라이머리 를 추적하는 시간(초)입니다. 이 값을 |
sslEnabled | 부울 |
|
systemInfo | 객체 | 운영 체제 또는 container에서 보고한 이 MongoDB 프로세스 서버에 대한 RAM 및 CPU 정보가 포함된 객체입니다. |
systemInfo.memSizeMB | 숫자 | RAM 용량(MB)입니다. |
systemInfo.numCores | 숫자 | CPU 코어 수입니다. |
typeName | 문자열 | 이 MongoDB 프로세스를 입력합니다. 가능한 값은 다음과 같습니다.
Ops Manager에 추가된 새 호스트의 유형은 모니터링이 첫 번째 핑을 받을 때까지 |
uptimeMsec | 숫자 | 이 프로세스를 마지막으로 다시 시작한 이후의 밀리초 수입니다. |
버전 | 문자열 | 이 프로세스에 대해 실행 중인 MongoDB의 버전입니다. |
참고
일부 호스트는 clusterId 를 반환하지 않습니다. 이는 mongos 프로세스 가 데이터 작업을 데이터를 저장 하지 않는 샤드로 라우팅할 때 발생합니다. MongoDB Ops Manager 는 일부 비데이터 보유 노드에 clusterId 를 할당하지 않습니다.
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/hosts?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}
응답 본문
1 { 2 "totalCount" : 2, 3 "results" : [ 4 { 5 "alertsEnabled" : true, 6 "aliases": [ "{HOSTNAME}:26000", "{IP-ADDRESS}:26000" ], 7 "authMechanismName" : "SCRAM-SHA-1", 8 "clusterId" : "{CLUSTER-ID}", 9 "created" : "2024-04-22T19:56:50Z", 10 "groupId" : "{PROJECT-ID}", 11 "hasStartupWarnings" : false, 12 "hidden" : false, 13 "hostEnabled" : true, 14 "hostname" : "{HOSTNAME}", 15 "id" : "{HOST-ID}", 16 "ipAddress": "127.0.0.1", 17 "journalingEnabled" : false, 18 "lastDataSizeBytes" : 633208918, 19 "lastIndexSizeBytes" : 101420524, 20 "lastPing" : "2024-08-18T11:23:41Z", 21 "links" : [ ], 22 "logsEnabled" : false, 23 "lowUlimit" : false, 24 "muninEnabled" : false, 25 "port" : 26000, 26 "profilerEnabled" : false, 27 "replicaSetName": "rs1", 28 "replicaStateName" : "PRIMARY", 29 "sslEnabled" : true, 30 "systemInfo" : { 31 "memSizeMB" : 65536, 32 "numCores" : 16 33 }, 34 "typeName": "REPLICA_PRIMARY", 35 "uptimeMsec": 1827300394, 36 "username" : "mongo", 37 "version" : "4.4.0" 38 }, 39 { 40 41 } 42 ] 43 }
참고
가 MongoDB Ops Manager 응답에서 muninEnabled 를 반환하지만, Munin 은 부터 MongoDB Ops Manager 4 지원되지4 않습니다.