모든 경고 가져오기
이 페이지의 내용
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alerts
요청 경로 매개변수
Parameter | 유형 | 설명 |
---|---|---|
프로젝트 ID | 문자열 | (필수 사항) 프로젝트 식별자입니다. |
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. | 1 |
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | 옵션 | false | |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 | false |
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다. | true |
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
status | 문자열 | 옵션 | 지정된 상태의 경고만 반환하려면 상태를 지정합니다. 모든 경고를 반환하려면 생략합니다. Ops Manager는 다음 값을 허용합니다.
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 경고입니다.
이름 | 유형 | 설명 |
---|---|---|
acknowledged Until | 문자열 | ISO 8601 의 타임스탬프 경고가 승인될 때까지의 날짜 및 시간 형식(UTC )입니다. 경고가 승인된 경우 Ops Manager는 이 값을 반환합니다. |
acknowledgement Comment | 문자열 | 경고를 승인한 사용자가 남긴 댓글입니다. 경고가 승인된 경우 Ops Manager는 이 값을 반환합니다. |
acknowledging Username | 문자열 | 경고를 승인한 사용자의 사용자 이름입니다. 경고가 승인된 경우 Ops Manager는 이 값을 반환합니다. |
alertConfigId | 문자열 | 이 경고를 트리거한 경고 구성의 고유 식별자입니다. |
clusterId | 문자열 | 이 경고가 적용되는 cluster의 고유 식별자입니다. Ops Manager는 다음과 같은 경우 이 값을 반환합니다.
|
clusterName | 문자열 | 이 경고가 적용되는 cluster의 이름입니다. Ops Manager는 다음과 같은 경우 이 값을 반환합니다.
|
created | 문자열 | ISO 8601 의 타임스탬프 경고가 열린 시점의 UTC 날짜 및 시간 형식입니다. |
currentValue | 객체 | 경고를 트리거한 메트릭의 현재 값입니다.
|
currentValue .number | 숫자 | 지표의 값입니다. |
currentValue .units | 문자열 | 값의 단위입니다. 값은 지표 유형에 따라 달라집니다. 예를 예시 메모리 소비를 측정하는 메트릭에는 바이트 측정이 있고 시간을 측정하는 메트릭에는 시간 단위가 있습니다. Ops Manager는 다음을 반환할 수 있습니다.
|
eventTypeName | 문자열 | 경고를 트리거한 이벤트의 이름입니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요. |
groupId | 문자열 | 이 경고가 열린 그룹의 고유 식별자입니다. |
hostId | 문자열 | 지표가 속한 호스트의 고유 식별자입니다.
|
hostnameAndPort | 문자열 | 경고가 적용되는 각 호스트의 호스트 이름 및 포트입니다. 이는 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소일 수 있습니다.
|
id | 문자열 | 경고의 고유 식별자입니다. |
lastNotified | 문자열 | ISO 8601 의 타임스탬프 이 경고에 대해 마지막으로 알림을 보낸 날짜 및 시간 형식(UTC )입니다. MongoDB Ops Manager는 알림이 전송된 경우 이 값을 반환합니다. |
links | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
metricName | 문자열 | 값이 임계값을 벗어난 측정값의 이름입니다.
사용 가능한 값 은 경고의 측정 유형을 참조하세요. |
replicaSetName | 문자열 | 복제본 세트의 이름입니다.
|
resolved | 문자열 | ISO 8601 의 타임스탬프 경고가 종료된 시점의 UTC 날짜 및 시간 형식입니다.
|
status | 문자열 | 경고의 현재 상태입니다. Ops Manager는 다음 중 하나를 반환할 수 있습니다.
|
sourceTypeName | 문자열 |
|
tags | 문자열 배열 | 이 경고에 설정된 식별 라벨입니다. |
updated | 문자열 | ISO 8601 의 타임스탬프 경고가 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다. |
경고의 측정 유형
alerts
리소스는 metricName
필드의 측정 유형을 반환합니다. 이 필드는 eventTypeName
가 OUTSIDE_METRIC_THRESHOLD
로 설정된 경우에만 표시됩니다.
호스트 측정
| serverStatus 명령이 생성하는 asserts 문서에서 발견된 MongoDB 프로세스에 대한 어설션 비율입니다. |
| 백그라운드에서 플러시된 데이터의 양입니다. |
| serverStatus 명령이 생성하는 및 문서에서 발견된 캐시 및 WiredTiger storage engine wiredTiger.cache 티켓의 wiredTiger.concurrentTransactions 바이트 양입니다. |
| serverStatus 명령이 생성하는 connections 문서에서 발견된 MongoDB 프로세스에 대한 연결 수입니다. |
| |
| MongoDB 프로세스의 Memory Issues 및 Page Faults 의 숫자입니다. |
| serverStatus 명령이 생성하는 MongoDB 프로세스 의 잠금을 대기 중인 작업의 수입니다. MongoDB Ops Manager 는 스토리지 엔진 유형에 따라 이러한 값을 계산합니다. |
| 인덱스 btree 연산의 수입니다. |
| 저널링 연산의 수입니다. |
| serverStatus 명령이 수집하는 mem 문서에서 발견된 MongoDB 프로세스의 메모리 양입니다. |
| serverStatus 명령이 수집하는 network 문서에서 발견된 MongoDB 프로세스의 처리량입니다. |
| MongoDB 프로세스의 oplog 기간 및 처리량입니다. |
| MongoDB dbStats 명령에서 수집된 디스크 상의 저장 공간입니다. |
| serverStatus 명령이 수집하는 opcounters 문서에서 확인된 프로세스가 마지막으로 시작된 이후 MongoDB 프로세스에 대한 데이터베이스 작업의 비율입니다. |
| |
| 선택한 기간 동안 초당 반환, 삽입, 업데이트 또는 삭제된 문서의 평균 비율입니다. |
| 선택한 기간 동안 정렬을 수행하지만 인덱스를 사용하여 정렬을 수행할 수 없는 초당 작업의 평균 비율입니다. |
| 선택한 기간 동안 읽기, 쓰기 또는 명령 작업당 평균 실행 시간(밀리초)입니다. MongoDB 3.4 이상을 실행하는 호스트에서 사용할 수 있습니다. |
| 이전 1시간 동안 호스트가 재시작된 횟수입니다. |
| 물리적 메모리 사용량(단위: 바이트)입니다. |
| 초당 바이트 단위의 네트워크 처리량입니다. |
| 사용 중인 총 스왑 공간입니다. |
| 설명 명령의 totalKeysExamined 값에 있는 쿼리 및 쿼리 계획 평가 중 인덱스 항목을 스캔하는 초당 평균 속도입니다. |
| 설명 명령의 totalDocsExamined 값에서 발견된 쿼리 및 쿼리 계획 평가 중에 초당 스캔된 문서의 평균 속도입니다. |
| 반환된 문서 수에 대한 스캔된 인덱스 항목 수의 비율입니다. |
| 반환된 문서 수에 대한 스캔된 문서 수의 비율입니다. |
요청 예시
다음은 모든 OPEN
경고를 반환합니다.
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&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 "links" : [ { 3 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts?status=OPEN&pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "alertConfigId" : "5953c5f380eef53887615fd4", 8 "created" : "2019-07-18T23:43:50Z", 9 "eventTypeName" : "MONITORING_AGENT_DOWN", 10 "groupId" : "{PROJECT-ID}", 11 "id" : "5d31043680eef5280d3664e0", 12 "lastNotified" : "2019-09-25T11:50:08Z", 13 "links" : [ { 14 "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/5d31043680eef5280d3664e0", 15 "rel" : "self" 16 } ], 17 "status" : "OPEN", 18 "tags" : [ ], 19 "updated" : "2019-07-18T23:43:50Z" 20 } ], 21 "totalCount" : 1 22 }