하나의 글로벌 경고 구성으로 트리거되는 모든 열려 있는 경고 가져오기

이 페이지의 내용

필수 역할

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

GLOBAL-ALERT-CONFIG-ID 로 식별되는 전역 경고 구성에 의해 트리거되는 모든 열려 있는 경고를 조회합니다.

필수 역할

다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.

요청

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

GET /globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts

요청 경로 매개변수

이름	유형	필요성	설명
`{GLOBAL-ALERT-CONFIG-ID}`	문자열	필수 사항	열려 있는 경고를 검색하려는 전역 경고 구성의 고유 식별자입니다.

요청 쿼리 매개변수

이름	유형	필요성	설명	기본값
pageNum	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
itemsPerPage	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
pretty	부울	옵션	응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 `envelope : true`를 설정합니다. 결과 목록을 반환하는 엔드포인트의 경우 `content` 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 `status` 필드를 추가합니다.	`false`

요청 본문 매개변수

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

응답

응답 문서

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

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

`results` embeddedDocument

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

이름

유형

설명

acknowledgedUntil

문자열

ISO 8601 의 타임스탬프 경고가 승인된 UTC 의 날짜 및 시간 형식입니다. 사용자가 이 경고를 확인한 경우 MongoDB Ops Manager에 이 필드가 표시됩니다.

acknowledgementComment

문자열

이 경고를 승인한 사용자가 남긴 댓글입니다. 사용자가 이 경고를 확인한 경우 Ops Manager에 이 필드가 표시됩니다.

acknowledgingUsername

문자열

경고를 승인한 사용자의 Ops Manager 사용자 이름입니다. 사용자가 이 경고를 확인한 경우 Ops Manager에 이 필드가 표시됩니다.

alertConfigId

문자열

이 경고를 트리거한 전역 경고 구성의 고유 식별자입니다.

clusterId

문자열

이 경고가 적용되는 클러스터의 고유 식별자입니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

clusterName

문자열

Name the cluster to which this alert applies. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

created

문자열

ISO 8601 의 타임스탬프 경고가 생성된 시점의 UTC 날짜 및 시간 형식입니다.

currentValue

객체

경고를 트리거한 메트릭의 현재 값입니다. Ops Manager는 호스트 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

currentValue.number

숫자

지표의 현재 값입니다.

currentValue.units

문자열

currentValue.number 의 단위입니다. 단위는 메트릭 유형에 따라 다릅니다.

허용되는 값은 다음과 같습니다.

RAW
BITS
BYTES
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
GIGABITS
GIGABYTES
TERABYTES
PETABYTES
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS

예를 예시 메모리 소비를 측정하는 지표에는 BYTES, 시간을 측정하는 지표에는 HOURS 를 사용할 수 있습니다.

eventTypeName

문자열

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

경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요.

Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.

groupId

문자열

이 경고가 열린 프로젝트의 고유 식별자입니다.

hostId

문자열

Unique identifier of the host to which the metric pertains. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

hostnameAndPort

문자열

경고가 적용되는 각 호스트의 호스트 이름 및 포트입니다. 호스트 이름은 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소만 가능합니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

id

문자열

경고의 고유 식별자입니다.

lastNotified

문자열

ISO 8601 의 타임스탬프 이 경고에 대해 마지막으로 알림을 보낸 날짜 및 시간 형식(UTC )입니다. MongoDB Ops Manager가 알림을 보낸 경우 MongoDB Ops Manager가 이를 표시합니다.

metricName

문자열

값이 임계값을 벗어난 측정값의 이름입니다. "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD" 인 경우 Ops Manager가 이 필드를 반환합니다.

사용 가능한 값 은 글로벌 경고의 측정 유형을 참조하세요.

replicaSetName

문자열

복제본 세트의 이름입니다. Ops Manager는 다음 카테고리의 글로벌 경고에 대해 이 필드를 반환합니다.

resolved

문자열

ISO 8601 의 타임스탬프 경고가 종료된 시점의 UTC 날짜 및 시간 형식입니다. MongoDB Ops Manager는 "status" : "CLOSED" 인 경우 전역 경고에 대해 이 필드를 반환합니다.

sourceTypeName

문자열

백업되는 호스트 유형입니다. Ops Manager는 backup 카테고리의 전역 경고에 대해 이 필드를 반환합니다. 반환될 수 있는 가능한 값은 다음과 같습니다.

REPLICA_SET
SHARDED_CLUSTER
CONFIG_SERVER

status

문자열

경고의 현재 상태입니다. 반환될 수 있는 가능한 값은 다음과 같습니다.

`TRACKING`	경고 조건이 존재하지만 경고를 트리거할 만큼 충분히 오랫동안 지속되지 않았습니다.
`OPEN`	경고가 열려 있습니다.
`CLOSED`	경고가 닫힙니다.
`CANCELLED`	경고가 취소되었습니다.

tags

문자열 배열

이 경고와 관련된 태그입니다.

typeName

문자열

이 필드는 더 이상 사용되지 않으며 무시됩니다.

updated

문자열

ISO 8601 의 타임스탬프 이 경고가 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다.

요청 예시

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2      --header "Accept: application/json" \
3      --include \
4      --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-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}

응답 본문

1 {
2   "links": [],
3   "results": [{
4     "alertConfigId": "{ALERT-CONFIG-ID}",
5     "created": "2019-11-29T20:26:30Z",
6     "eventTypeName": "BACKUP_AGENT_DOWN",
7     "groupId": "{PROJECT-ID}",
8     "id": "{ALERT-ID}",
9     "lastNotified": "2020-04-09T20:21:00Z",
10     "links": [],
11     "status": "OPEN",
12     "tags": [],
13     "typeName": "AGENT",
14     "updated": "2019-11-29T20:26:30Z"
15   },
16   {
17     "alertConfigId": "{ALERT-CONFIG-ID}",
18     "created": "2019-11-29T20:43:00Z",
19     "eventTypeName": "BACKUP_AGENT_DOWN",
20     "groupId": "{PROJECT-ID}",
21     "id": "{ALERT-ID}",
22     "lastNotified": "2020-04-09T20:21:54Z",
23     "links": [],
24     "status": "OPEN",
25     "tags": [],
26     "typeName": "AGENT",
27     "updated": "2019-11-29T20:43:00Z"
28   },
29   {
30     "alertConfigId": "{ALERT-CONFIG-ID}",
31     "created": "2019-11-30T12:27:07Z",
32     "eventTypeName": "BACKUP_AGENT_DOWN",
33     "groupId": "{PROJECT-ID}",
34     "id": "{ALERT-ID}",
35     "lastNotified": "2020-04-09T20:20:33Z",
36     "links": [],
37     "status": "OPEN",
38     "tags": [],
39     "typeName": "AGENT",
40     "updated": "2019-11-30T12:27:07Z"
41   }
42   ],
43   "totalCount": 3
44 }

돌아가기

모든 전역 경고 구성 가져오기

1개의 글로벌 경고 구성 가져오기

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2	--header "Accept: application/json" \
3	--include \
4	--request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/globalAlertConfigs/{GLOBAL-ALERT-CONFIG-ID}/alerts"

1	{
2	"links": [],
3	"results": [{
4	"alertConfigId": "{ALERT-CONFIG-ID}",
5	"created": "2019-11-29T20:26:30Z",
6	"eventTypeName": "BACKUP_AGENT_DOWN",
7	"groupId": "{PROJECT-ID}",
8	"id": "{ALERT-ID}",
9	"lastNotified": "2020-04-09T20:21:00Z",
10	"links": [],
11	"status": "OPEN",
12	"tags": [],
13	"typeName": "AGENT",
14	"updated": "2019-11-29T20:26:30Z"
15	},
16	{
17	"alertConfigId": "{ALERT-CONFIG-ID}",
18	"created": "2019-11-29T20:43:00Z",
19	"eventTypeName": "BACKUP_AGENT_DOWN",
20	"groupId": "{PROJECT-ID}",
21	"id": "{ALERT-ID}",
22	"lastNotified": "2020-04-09T20:21:54Z",
23	"links": [],
24	"status": "OPEN",
25	"tags": [],
26	"typeName": "AGENT",
27	"updated": "2019-11-29T20:43:00Z"
28	},
29	{
30	"alertConfigId": "{ALERT-CONFIG-ID}",
31	"created": "2019-11-30T12:27:07Z",
32	"eventTypeName": "BACKUP_AGENT_DOWN",
33	"groupId": "{PROJECT-ID}",
34	"id": "{ALERT-ID}",
35	"lastNotified": "2020-04-09T20:20:33Z",
36	"links": [],
37	"status": "OPEN",
38	"tags": [],
39	"typeName": "AGENT",
40	"updated": "2019-11-30T12:27:07Z"
41	}
42	],
43	"totalCount": 3
44	}