지정한 시간과 날짜까지 하나의 경고를 승인할 수 있습니다. 과거 날짜와 시간을 지정하여 경고를 승인 취소할 수도 있습니다.
필수 역할
다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /globalAlerts/{ALERT-ID}요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 확인하려는 경고 의 고유 식별자입니다. |
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
본문 매개변수 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 문자열 | 필수 사항 | 이 경고 확인하는 UTC의 ISO 8601 날짜 및 시간 형식의 타임스탬프입니다. 이 시간이 지나면 Ops Manager 경고 를 승인되지 않음으로 되돌립니다. 경고가 곧 다시 시작되지 않도록 하려면 날짜와 시간을 먼 미래로 설정합니다. 경고를 승인 취소하려면 과거의 시간과 날짜를 지정합니다. |
| 문자열 | 옵션 | 경고 확인을 설명하는 댓글입니다. |
응답
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 경고가 승인된 UTC 의 ISO 8601 날짜 및 시간 형식의 타임스탬프입니다. 사용자가 이 경고를 확인한 경우 MongoDB Ops Manager에 이 필드가 표시됩니다. |
| 문자열 | 이 경고를 승인한 사용자가 남긴 댓글입니다. 사용자가 이 경고를 확인한 경우 Ops Manager에 이 필드가 표시됩니다. |
| 문자열 | 경고를 승인한 사용자의 Ops Manager 사용자 이름입니다. 사용자가 이 경고를 확인한 경우 Ops Manager에 이 필드가 표시됩니다. |
| 문자열 | 이 경고를 트리거한 전역 경고 구성의 고유 식별자입니다. |
| 문자열 | 이 경고가 적용되는 클러스터의 고유 식별자입니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 문자열 | Name the cluster to which this alert applies. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 문자열 | 경고가 생성된 시점의 ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프입니다. |
| 객체 | 경고를 트리거한 메트릭의 현재 값입니다. Ops Manager는 호스트 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 숫자 | 지표의 현재 값입니다. |
| 문자열 |
허용되는 값은 다음과 같습니다.
예를 예시 메모리 소비를 측정하는 지표에는 |
| 문자열 | 경고를 트리거한 이벤트의 이름입니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요. |
| 문자열 | 이 경고가 열린 프로젝트의 고유 식별자입니다. |
| 문자열 | Unique identifier of the host to which the metric pertains. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 문자열 | 경고가 적용되는 각 호스팅하다의 호스팅하다 이름 및 포트입니다. 호스트 이름은 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소일 수 있습니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 문자열 | 경고의 고유 식별자입니다. |
| 문자열 | 이 경고 에 대해 마지막으로 알림이 전송된 시점의 ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프입니다. MongoDB Ops Manager 가 알림을 보낸 경우 Ops Manager 가 이것을 표시합니다. |
| 문자열 | 값이 임계값을 벗어난 측정값의 이름입니다. 사용 가능한 값 은 글로벌 경고의 측정 유형을 참조하세요. |
| 문자열 | 복제본 세트의 이름입니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다. |
| 문자열 | 경고 종료되었을 때 ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프입니다. Ops Manager |
| 문자열 | 백업되는 호스트 유형입니다. Ops Manager는 backup 카테고리의 전역 경고에 대해 이 필드를 반환합니다. 반환될 수 있는 가능한 값은 다음과 같습니다.
|
| 문자열 | 경고의 현재 상태입니다. 반환될 수 있는 가능한 값은 다음과 같습니다.
|
| 문자열 배열 | 이 경고와 관련된 태그입니다. |
| 문자열 | 이 필드는 더 이상 사용되지 않으며 무시됩니다. |
| 문자열 | 이 경고 마지막으로 업데이트된 시점의 ISO 8601 날짜 및 시간 형식(UTC)의 타임스탬프입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlerts/{ALERT-ID}" \ --data '{ "acknowledgedUntil":"2020-04-10T20:21:31Z", "acknowledgementComment":"test" }'응답 예시
응답 헤더
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
{ "acknowledgedUntil": "2020-04-10T20:20:38Z", "acknowledgementComment": "test", "acknowledgingUsername": "rwqvzark", "alertConfigId": "{ALERT-CONFIG-ID}", "created": "2019-12-02T20:39:54Z", "eventTypeName": "BACKUP_AGENT_DOWN", "groupId": "{PROJECT-ID}", "id": "{ALERT-ID}", "lastNotified": "2020-04-09T20:21:31Z", "links": [ ], "status": "OPEN", "tags": [], "typeName": "AGENT", "updated": "2020-04-10T19:14:38Z"}