문서 메뉴

문서 홈 → MongoDB Ops Manager

경고 구성에 대한 열려 있는 경고 가져오기

이 페이지의 내용

  • 리소스
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 문서
  • results embeddedDocument
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

리소스

GET /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts

요청 경로 매개변수

모든 요청 경로 매개변수는 필수 입니다.

매개변수
유형
설명
프로젝트 ID
문자열
이 프로젝트의 고유 식별자입니다.
ALERT-CONFIG-ID
문자열
이 경고 구성의 고유 식별자입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값
pageNum
숫자
옵션
결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.
1
itemsPerPage
숫자
옵션
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
옵션
응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope : true를 설정합니다.

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

false
backupJobsEnabledOnly
부울
옵션
데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.
true

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다.URL 간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 경고 구성입니다.

참고

경고 세부 정보는 다양합니다. 경고에는 이러한 요소의 하위 집합만 포함될 수 있습니다.

이름
유형
설명
acknowledgedUntil
문자열
ISO 8601 의 타임스탬프 경고가 승인된 UTC 의 날짜 및 시간 형식입니다. 경고가 승인된 경우 채워집니다.
승인 사용자 이름
문자열
경고를 승인한 사용자의 사용자 이름입니다. 경고가 승인된 경우 채워집니다.
acknowledgementComment
문자열
경고를 승인한 사용자가 댓글을 남겼습니다. 경고가 승인된 경우 채워집니다.
alertConfigId
문자열
이 경고를 트리거한 경고 구성의 고유 식별자입니다.
clusterId
문자열
이 경고가 적용되는 클러스터의 고유 식별자입니다. BACKUP, REPLICA_SET 및 CLUSTER 경고로 채워집니다.
clusterName
문자열
이 경고가 적용되는 cluster의 이름을 지정하세요. BACKUP, REPLICA_SET 및 CLUSTER 경고로 채워집니다.
생성됨
문자열
ISO 8601 의 타임스탬프 경고가 열린 시점의 UTC 날짜 및 시간 형식입니다.
currentValue
객체
경고를 트리거한 메트릭의 현재 값입니다. HOST_METRIC 경고로 채워집니다.
currentValue.number
숫자
지표의 값입니다.
currentValue.units
문자열

값의 단위입니다. 지표 유형에 따라 다릅니다.

예제

메모리 소비를 측정하는 지표에는 바이트 측정값이 있고, 시간을 측정하는 지표에는 시간 단위가 있습니다. 허용되는 값은 다음과 같습니다.

  • RAW

  • BITS

  • BYTES

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • GIGABITS

  • GIGABYTES

  • TERABYTES

  • PETABYTES

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

eventTypeName
문자열

경고를 트리거한 이벤트의 이름입니다.

값에는 다음이 포함됩니다.

에이전트

자동화 구성

백업

BI 커넥터

클러스터

액세스한 데이터 탐색기

호스트

조직

프로젝트

복제본 세트

팀

사용자

경고를 생성하는 이벤트의 전체 목록과 해당 설명을 검토하려면 경고 유형 을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.

groupId
문자열
이 경고가 열린 프로젝트의 고유 식별자입니다.
hostId
문자열
지표가 속한 호스트의 고유 식별자입니다. HOST, HOST_METRIC 및 REPLICA_SET 경고로 채워집니다.
호스트 이름 및 포트
문자열
경고가 적용되는 각 호스트의 호스트 이름 및 포트입니다. HOST, HOST_METRIC 및 REPLICA_SET 경고로 채워집니다.
id
문자열
경고의 고유 식별자입니다.
lastNotified
문자열
ISO 8601 의 타임스탬프 이 경고에 대해 마지막으로 알림을 보낸 날짜 및 시간 형식(UTC )입니다. 알림이 전송된 경우 채워집니다.
metricName
문자열

값이 임계값을 벗어난 측정값의 이름입니다. "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD" 인 경우 채워집니다.

허용되는 값은 이 페이지 에 있는 경고의 측정 유형을 참조하세요.

복제본 세트 이름
문자열
복제본 세트의 이름입니다. HOST, HOST_METRIC, BACKUP 및 REPLICA_SET 경고로 채워집니다.
해결됨
문자열
ISO 8601 의 타임스탬프 경고가 종료된 시점의 UTC 날짜 및 시간 형식입니다. 인 경우 채워집니다."status" : "CLOSED"
sourceTypeName
문자열

BACKUP 경고의 경우 백업되는 서버 유형입니다. 허용되는 값은 다음과 같습니다.

  • REPLICA_SET

  • SHARDED_CLUSTER

  • CONFIG_SERVER

상태
문자열

경고의 현재 상태입니다. 허용되는 값은 다음과 같습니다.

typeName
문자열
이 필드는 더 이상 사용되지 않으며 무시됩니다.
Updated
문자열
ISO 8601 의 타임스탬프 경고가 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다.

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
  --header 'Accept: application/json' \
  --include \
  --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}/alerts"

응답 예시

응답 헤더

HTTP/1.1 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
HTTP/1.1 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}

응답 본문

{
  "links" : [],
  "results" : [ {
    "acknowledgedUntil" : "2014-05-01T14:00:00Z",
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T15:57:13.562Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "53569159300495c7702ee3a3",
    "lastNotified" : "2014-04-22T15:57:24.126Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  }, {
    "alertConfigId":"{ALERT-CONFIG-ID}",
    "created" : "2014-04-22T19:59:10.657Z",
    "currentValue" : {
      "number" : 0.0,
      "units" : "RAW"
    },
    "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD",
    "groupId" : "{PROJECT-ID}",
    "id" : "5356ca0e300495c770333340",
    "lastNotified" : "2014-04-22T20:14:19.313Z",
    "links" : [],
    "metricName" : "ASSERT_REGULAR",
    "status" : "OPEN",
    "updated" : "2014-04-22T20:14:11.388Z"
  } ],
  "totalCount" : 2
}
← 경고 구성 삭제
이벤트 →

이 페이지의 내용