1개의 경고 승인
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
Resource
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/alerts/{ALERT-ID}
요청 경로 매개변수
Parameter | 유형 | 필요성 | 설명 |
---|---|---|---|
PROJECT-ID | 문자열 | 필수 사항 | 이 경고가 설정된 프로젝트의 고유 식별자입니다. |
ALERT-ID | 문자열 | 필수 사항 | 경고의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
필드 | 유형 | 필요성 | 설명 |
---|---|---|---|
acknowledged Until | 문자열 | 조건부 | ISO 8601 의 타임스탬프 경고를 승인해야 하는 UTC 의 날짜 및 시간 형식입니다.
|
acknowledgement Comment | 문자열 | 옵션 | 이 확인 이유에 대한 텍스트 설명입니다. Ops Manager는 경고가 승인되었다는 메시지 옆에 설명을 표시합니다. |
응답
반환 문서의 필드는 경고 유형에 따라 다릅니다.
이름 | 유형 | 설명 |
---|---|---|
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 )입니다. |
요청 예시
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alerts/{ALERT-CONFIG-ID}" 6 --data ' 7 { 8 "acknowledgedUntil": "2016-04-15T00:00:00-0400", 9 "acknowledgementComment": "This is normal. Please ignore." 10 }'
응답 예시
응답 헤더
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 "id" : "{ALERT-CONFIG-ID}", 3 "groupId" : "{PROJECT-ID}", 4 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", 5 "status" : "OPEN", 6 "acknowledgedUntil" : "2014-04-15T04:00:00Z", 7 "acknowledgementComment" : "This is normal. Please ignore.", 8 "acknowledgingUsername" : "someuser@example.com", 9 "created" : "2014-04-03T20:28:14Z", 10 "updated" : "2014-04-03T20:33:14Z", 11 "lastNotified" : "2014-04-03T20:33:23Z", 12 "metricName": "ASSERTS_REGULAR", 13 "currentValue" : { 14 "number" : 0.0, 15 "units" : "RAW" 16 }, 17 "links" : [] 18 }