1개의 경고 받기
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/alerts/{ALERT-ID}
요청 경로 매개변수
Parameter | 유형 | 설명 |
|---|---|---|
프로젝트 ID | 문자열 | (필수 사항) 프로젝트 식별자입니다. |
ALERT-ID | 문자열 | (필수 사항) 경고 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
반환 문서의 필드는 경고 유형에 따라 다릅니다.
이름 | 유형 | 설명 |
|---|---|---|
acknowledgedUntil | 문자열 | ISO 8601 의 타임스탬프 경고가 승인될 때까지의 날짜 및 시간 형식(UTC )입니다. 경고가 승인된 경우 Cloud Manager는 이 값을 반환합니다. |
acknowledgementComment | 문자열 | 경고를 승인한 사용자가 남긴 댓글입니다. 경고가 승인된 경우 Cloud Manager는 이 값을 반환합니다. |
acknowledgingUsername | 문자열 | 경고를 승인한 사용자의 사용자 이름입니다. 경고가 승인된 경우 Cloud Manager는 이 값을 반환합니다. |
alertConfigId | 문자열 | 이 경고를 트리거한 경고 구성의 고유 식별자입니다. |
clusterId | 문자열 | 이 경고가 적용되는 cluster의 고유 식별자입니다. Cloud Manager는 다음과 같은 경우 이 값을 반환합니다.
|
clusterName | 문자열 | 이 경고가 적용되는 cluster의 이름입니다. Cloud Manager는 다음과 같은 경우 이 값을 반환합니다.
|
created | 문자열 | ISO 8601 의 타임스탬프 경고가 열린 시점의 UTC 날짜 및 시간 형식입니다. |
currentValue | 객체 | 경고를 트리거한 메트릭의 현재 값입니다. Cloud Manager는 |
currentValue.number | 숫자 | 지표의 값입니다. |
currentValue.units | 문자열 | 값의 단위입니다. 값은 지표 유형에 따라 달라집니다. 예를 예시 메모리 소비를 측정하는 메트릭에는 바이트 측정이 있고 시간을 측정하는 메트릭에는 시간 단위가 있습니다. Cloud Manager는 다음을 반환할 수 있습니다.
|
eventTypeName | 문자열 | 경고를 트리거한 이벤트의 이름입니다. 허용되는 값은 다음과 같습니다. 에이전트
자동화 구성
백업
BI 커넥터
청구 클러스터
액세스한 데이터 탐색기
디스크 백업 호스트 조직 프로젝트 복제본 세트 지원 사례 팀
사용자 |
groupId | 문자열 | 이 경고가 열린 그룹의 고유 식별자입니다. |
hostId | 문자열 | 지표가 속한 호스트의 고유 식별자입니다. Cloud Manager는
|
hostnameAndPort | 문자열 | 경고가 적용되는 각 호스트의 호스트 이름 및 포트입니다. 이는 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소일 수 있습니다. Cloud Manager는
|
id | 문자열 | 경고의 고유 식별자입니다. |
lastNotified | 문자열 | ISO 8601 의 타임스탬프 이 경고에 대해 마지막으로 알림을 보낸 날짜 및 시간 형식(UTC )입니다. Cloud Manager는 알림이 전송된 경우 이 값을 반환합니다. |
links | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
metricName | 문자열 | 값이 임계값을 벗어난 측정값의 이름입니다. Cloud Manager는 사용 가능한 값 은 경고의 측정 유형을 참조하세요. |
replicaSetName | 문자열 | 복제본 세트의 이름입니다. Cloud Manager는
|
resolved | 문자열 | ISO 8601 의 타임스탬프 경고가 종료된 시점의 UTC 날짜 및 시간 형식입니다. Cloud Manager는 |
status | 문자열 | 경고의 현재 상태입니다. Cloud Manager는 다음 중 하나를 반환할 수 있습니다.
|
sourceTypeName | 문자열 |
|
tags | 문자열 배열 | 이 경고에 설정된 식별 라벨입니다. |
typeName | 문자열 | 더 이상 사용되지 않는 필드입니다. |mms| 은 이를 무시합니다. |
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 프로세스의 잠금을 대기 중인 작업의 수입니다. Cloud Manager 는 storage engine 유형에 따라 이러한 값을 계산합니다. |
| 인덱스 btree 연산의 수입니다. |
| 저널링 연산의 수입니다. |
| serverStatus 명령이 수집하는 mem 문서에서 발견된 MongoDB 프로세스의 메모리 양입니다. |
| serverStatus 명령이 수집하는 network 문서에서 발견된 MongoDB 프로세스의 처리량입니다. |
| MongoDB 프로세스의 oplog 기간 및 처리량입니다. |
| MongoDB dbStats 명령에서 수집된 디스크 상의 저장 공간입니다. |
| serverStatus 명령이 수집하는 opcounters 문서에서 확인된 프로세스가 마지막으로 시작된 이후 MongoDB 프로세스에 대한 데이터베이스 작업의 비율입니다. |
| |
| 선택한 기간 동안 초당 반환, 삽입, 업데이트 또는 삭제된 문서의 평균 비율입니다. |
| 선택한 기간 동안 정렬을 수행하지만 인덱스를 사용하여 정렬을 수행할 수 없는 초당 작업의 평균 비율입니다. |
| 선택한 기간 동안 읽기, 쓰기 또는 명령 작업당 평균 실행 시간(밀리초)입니다. MongoDB 3.4 이상을 실행하는 호스트에서 사용할 수 있습니다. |
| 이전 1시간 동안 호스트가 재시작된 횟수입니다. |
| 물리적 메모리 사용량(단위: 바이트)입니다. |
| 초당 바이트 단위의 네트워크 처리량입니다. |
| 사용 중인 총 스왑 공간입니다. |
| 설명 명령의 totalKeysExamined 값에 있는 쿼리 및 쿼리 계획 평가 중 인덱스 항목을 스캔하는 초당 평균 속도입니다. |
| 설명 명령의 totalDocsExamined 값에서 발견된 쿼리 및 쿼리 계획 평가 중에 초당 스캔된 문서의 평균 속도입니다. |
| 반환된 문서 수에 대한 스캔된 인덱스 항목 수의 비율입니다. |
| 반환된 문서 수에 대한 스캔된 문서 수의 비율입니다. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-ID}"
응답 예시
응답 헤더
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}
응답 본문
{ "alertConfigId" : "5b43d04087d9d6357de591aa", "created" : "2019-07-26T21:12:19Z", "currentValue" : { "number" : 100, "units" : "RAW" }, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "humanReadable" : "Project: testProj Organization: testOrg Alert acknowledged by user@example.com until 2019/10/17 19:48 GMT. Comment: N/A Connections has gone below 1000 mycluster.example.com:27017 Created: 2019/10/17 15:26 GMT Replica Set: cluster0-shard-0 Type: Primary Current Value: 100" "groupId" : "535683b3794d371327b", "hostnameAndPort" : "mycluster.example.com:27017", "id" : "533cb4b8e4b0f1820cdabc7f", "lastNotified" : "2019-07-26T21:13:48Z", "metricName" : "CONNECTIONS", "replicaSetName" : "mycluster", "resolved" : "2019-07-26T21:13:42Z", "status" : "CLOSED", "typeName" : "HOST_METRIC", "updated" : "2019-07-26T21:13:42Z", "links" : [ ... ] }