필수 역할
다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{PROJECT-ID}/agents/versions
요청 경로 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 문자열 | 필수 사항 | 프로젝트의 고유 식별자입니다. |
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 |
|---|---|---|
| integer | Ops Manager 애플리케이션이 발견한 에이전트의 수입니다. |
| 객체 배열 | 이 Ops Manager 애플리케이션이 managed하는 모든 호스트의 각 에이전트에 대한 세부 정보입니다. |
entries.address | 문자열 | 이 에이전트를 실행하는 호스트의 IPv6 주소입니다. |
entries.hostname | 문자열 | 이 에이전트를 실행하는 호스트의 FQDN 입니다. |
entries.hostnameShort | 문자열 | 이 에이전트를 실행하는 호스트 이름입니다. |
entries.version | 문자열 | 이 호스트가 실행하는 이 에이전트의 버전입니다. |
entries.pingCount | integer | 이 에이전트로부터 수신한 핑의 수입니다. |
entries.confCount | integer | 이 에이전트로부터 수신된 구성 호출의 개수입니다. |
entries.tagName | 문자열 | 백업이 활성화된 경우 이 에이전트의 레이블입니다. |
entries.lastPing | 숫자 | MongoDB Ops Manager 이 Agent로부터 마지막 핑 수신한 UNIX epoch 이후 경과된 시간(밀리초)을 타임스탬프로 표시합니다. Monitoring Agents 및 Monitoring이 활성화된 MongoDB Agents에 적용됩니다. |
entries.lastConf | 숫자 | MongoDB Ops Manager 이 Agent로부터 마지막 구성 호출을 수신했을 때 UNIX epoch 이후 경과된 시간(밀리초)을 타임스탬프로 표시합니다. |
entries.msSinceLastConf | 숫자 | 마지막 구성 호출 이후 경과된 밀리초 수입니다. |
entries.isPrimary | 부울 | 이 에이전트가 실행되는 호스트가 프라이머리인지 여부를 나타내는 플래그입니다. |
entries.isManaged | 부울 | Ops Manager가 이 에이전트를 managed 여부를 나타내는 플래그입니다. 모니터링 및 백업 에이전트에만 적용됩니다. |
entries.numProcess | integer | 이 호스트에서 실행되는 MongoDB 프로세스의 수입니다. |
entries.isVersionOld | 부울 | 설치된 에이전트가 오래되었음을 나타내는 플래그입니다. 이 에이전트의 현재 릴리스된 버전이 설치된 에이전트의 버전을 초과합니다. |
entries.isVersionDeprecated | 부울 | 이 에이전트가 더 이상 사용되지 않음을 나타내는 플래그입니다. 이 에이전트의 최소 지원 버전이 설치된 에이전트의 버전을 초과합니다. |
entries.pingState | 문자열 | 이 에이전트의 현재 상태입니다.
|
entries.isModule | 부울 | 이 항목이 MongoDB Agent의 모듈임을 나타내는 플래그입니다. |
| 부울 | 관리되지 않는 상태의 호스트에서 실행되는 에이전트가 있는지를 나타내는 플래그입니다. |
| 부울 | 배포서버에서 해당 에이전트의 더 이상 사용되지 않는 버전을 실행하는 에이전트가 있는지 여부를 나타내는 플래그입니다. |
| 부울 | 배포서버에서 해당 에이전트의 최신 버전이 아닌 버전을 실행하는 에이전트가 있는지를 나타내는 플래그입니다. |
| 문자열 | 이 유형의 에이전트의 최신 버전입니다. |
| 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
| 문자열 | 이 호스트에 설치된 이 에이전트의 최소 지원 버전입니다. |
| 문자열 | Ops Manager 설치와 함께 작동하는 이 에이전트의 최소 지원 버전입니다. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --request GET "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/versions?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 "count": 0, 3 "entries": [], 4 "isAnyAgentNotManaged": false, 5 "isAnyAgentVersionDeprecated": false, 6 "isAnyAgentVersionOld": false, 7 "latestVersion": "10.14.0.6304", 8 "links": [{ 9 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/agents/current", 10 "rel": "self" 11 }, 12 { 13 "href": "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}", 14 "rel": "http://mms.mongodb.com/group" 15 } 16 ], 17 "minimumAgentVersionDetected": "10.14.0.6304", 18 "minimumVersion": "5.0.0.309" 19 }