모든 조직 이벤트 가져오기

이 페이지의 내용

필수 역할

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

필수 역할

이 리소스 를 성공적으로 호출하려면 API 키에 Organization Member 역할 이 있어야 합니다.

요청

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

GET /orgs/{orgId}/events

요청 경로 매개변수

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

요청 쿼리 매개변수

고유 쿼리 매개변수

이 엔드포인트는 반환된 이벤트를 필터링하기 위해 다음 쿼리 매개변수를 허용합니다.

이름	유형	설명	기본값
eventType	문자열	지정된 유형의 이벤트만 반환합니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.
includeRaw	부울	출력에 `raw` 문서를 포함할지 여부를 지정합니다. `raw` 문서에는 이벤트에 대한 추가 메타 정보가 포함되어 있습니다. 중요: `raw` 문서 의 값은 변경될 수 있습니다. 공식 모니터링 을 위해 `raw` 값에 의존하지 마세요.	`false`
minDate	문자열	생성된 날짜가 ISO 8601 의 지정된 타임스탬프보다 크거나 같은 이벤트만반환합니다. UTC 의 날짜 및 시간 형식입니다.
maxDate	문자열	생성된 날짜가 ISO 8601 의 지정된 타임스탬프보다 작거나 같은 이벤트만 반환합니다. UTC 의 날짜 및 시간 형식입니다.

일반 쿼리 매개변수

이 엔드포인트는 또한 값 목록을 반환하는 모든 엔드포인트에 공통된 쿼리 매개변수를 허용합니다.

이름

유형

설명

기본값

pageNum

integer

페이지 번호(1-인덱스 기준)입니다.

1

itemsPerPage

integer

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타냅니다.

false

envelope

부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

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

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

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

none

요청 본문 매개변수

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

응답

응답 문서

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

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

`results` embeddedDocument

각 결과 는 하나의 이벤트입니다.

이름	유형	설명
alertId	문자열	이 이벤트와 연결된 경고의 고유 식별자입니다.
alertConfigId	문자열	`alertId` 와 연결된 경고 구성의 고유 식별자입니다.
apiKeyId	문자열	이 이벤트를 트리거한 API 키 의 고유 식별자입니다. 이 필드가 응답에 있는 경우 Ops Manager는 `userId` 필드를 반환하지 않습니다.
clusterId	문자열	이 이벤트가 적용되는 cluster의 고유 식별자입니다.
clusterName	문자열	이 이벤트가 적용되는 cluster의 이름입니다.
컬렉션	문자열	이벤트가 발생한 collection의 이름입니다. 이 필드는 `eventTypeName` 가 `DATA_EXPLORER` 또는 `DATA_EXPLORER_CRUD` 일 때 존재할 수 있습니다.
생성됨	문자열	ISO 8601 의 타임스탬프 이 이벤트가 트리거된 시점의 UTC 날짜 및 시간 형식입니다.
currentValue	객체	이 이벤트를 트리거한 지표의 현재 값입니다.
currentValue .number	숫자	지표의 값입니다.
currentValue .units	문자열	값의 관련 단위입니다. 예를 예시 메모리 소비를 측정하는 메트릭에는 바이트 측정이 있고 시간을 측정하는 메트릭에는 시간 단위가 있습니다. 허용되는 값은 다음과 같습니다. `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
database	문자열	이벤트가 발생한 데이터베이스의 이름입니다. 이 필드는 `eventTypeName` 가 `DATA_EXPLORER` 또는 `DATA_EXPLORER_CRUD` 일 때 존재할 수 있습니다.
diffs	객체 배열	이 이벤트 기간 동안 배포에 적용된 변경 사항입니다. Ops Manager는 변경된 사항에 따라 사용자 권한 또는 역할, 복원 작업, 자동화 모듈 등 다양한 요소를 반환합니다. 이 배열과 해당 배열의 객체 목록은 완전하지 않습니다.
diffs .id	문자열	이 이벤트에서 실행된 차이점에 대한 고유 식별자입니다.
diffs .params	객체 배열	지정된 리소스에 대한 변경 사항의 컬렉션입니다.
diffs .params .display	문자열	변경 시 콘솔 활동 피드에 표시되었던 라벨입니다.
diffs .params .new	문자열	변경된 매개변수의 새 상태입니다.
diffs .params .old	문자열	변경된 매개변수의 초기 상태입니다.
diffs .params .param	문자열	변경된 매개변수의 이름입니다.
diffs .status	문자열	이 리소스에 대한 변경 사항의 특성입니다. `NEW` `MODIFIED` `REMOVED` `SHUTDOWN` `STARTUP` `RESTORE` `RESTART`
diffs .type	문자열	변경이 적용된 리소스입니다. `AUTH` `AUTOMATION_AGENT` `BACKUP_AGENT` `BI_CONNECTOR` `MONITORING_AGENT` `PROCESS` `REPLICA_SET` `ROLES` `USERS`
eventTypeName	문자열	이 이벤트를 트리거한 상황의 이름입니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.
groupId	문자열	이 이벤트가 발생한 프로젝트의 고유 식별자입니다.
hostId	문자열	이 이벤트가 발생한 호스트의 고유 식별자입니다.
호스트 이름	문자열	이벤트가 발생한 호스트의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소입니다.
id	문자열	이 이벤트의 고유 식별자입니다.
isGlobalAdmin	부울	이 이벤트를 트리거한 사용자에게 `Global Monitoring Administrator` 역할이 있는지 여부를 나타내는 플래그입니다.
링크	객체 배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
metricName	문자열	값이 임계값을 벗어난 측정값의 이름입니다.
opType	문자열	이벤트를 생성한 작업 유형입니다. 이 필드는 `eventTypeName` 가 `DATA_EXPLORER` 또는 `DATA_EXPLORER_CRUD` 일 때 표시됩니다.
포트	integer	이 이벤트와 관련된 호스트의 포트입니다.
publicKey	문자열	이 이벤트를 트리거한 API 키 와 연결된 공개 키입니다. 이 필드가 응답에 있는 경우 Ops Manager는 `username` 필드를 반환하지 않습니다.
원시	문서	이벤트에 대한 추가 메타 정보입니다. 이 필드는 `includeRaw` 쿼리 매개변수가 `true` 인 경우에만 표시됩니다. 중요: `raw` 문서 의 값은 변경될 수 있습니다. 공식 모니터링 을 위해 `raw` 값에 의존하지 마세요.
원격 주소	문자열	이벤트를 트리거한 Ops Manager 사용자(userId)와 연결된 IP 주소입니다.
복제본 세트 이름	문자열	복제본 세트의 이름입니다.
shardName	문자열	이벤트와 연결된 샤드의 이름입니다.
targetPublicKey	문자열	이벤트의 대상이 되는 API 키 의 공개 키입니다.
targetUsername	문자열	이 이벤트의 대상이 되는 Ops Manager 사용자의 사용자 이름입니다.
teamId	문자열	이 이벤트와 연결된 Ops Manager 팀의 고유 식별자입니다.
userId	문자열	이 이벤트를 트리거한 Ops Manager 사용자의 고유 식별자입니다. 이 필드가 응답에 있는 경우 Ops Manager는 `apiKeyId` 필드를 반환하지 않습니다.
사용자 이름	문자열	이 이벤트를 트리거한 Ops Manager 사용자의 사용자 이름입니다. 이 필드가 응답에 있는 경우 Ops Manager는 `publicKey` 필드를 반환하지 않습니다.
accessListEntry	문자열	이벤트의 대상이 되는 API 키의 액세스 목록 항목입니다.

요청 예시

curl --user "{publicKey}:{privateKey}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{orgId}/events?pretty=true"

응답 예시

응답 헤더

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   "alertConfigId": "{alertConfigId}",
3   "alertId": "{alertId}",
4   "clusterId": "{clusterId}",
5   "clusterName": "Test Cluster",
6   "created": "2018-06-11T12:34:56Z",
7   "currentValue": {
8     "number": 50,
9     "units": "RAW"
10   },
11   "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12   "groupId": "{groupId}",
13   "hostId": "{hostId}",
14   "hostname": "db.example.com",
15   "id": "{globalAlertId}",
16   "isGlobalAdmin": false,
17   "maintenanceWindowId": "{maintenanceWindowId}",
18   "metricName": "OPCOUNTER_CMD",
19   "orgId": "{orgId}",
20   "port": 27017,
21   "remoteAddress": "192.168.1.1",
22   "replicaSetName": "rs1",
23   "shardName": "sh1",
24   "userId": "{userId}",
25   "username": "john.doe@example.com",
26   "targetUsername": "jane.doe@example.com",
27   "teamId": "{teamId}"
28 }

돌아가기

이벤트

Get One(조직)

1	{
2	"alertConfigId": "{alertConfigId}",
3	"alertId": "{alertId}",
4	"clusterId": "{clusterId}",
5	"clusterName": "Test Cluster",
6	"created": "2018-06-11T12:34:56Z",
7	"currentValue": {
8	"number": 50,
9	"units": "RAW"
10	},
11	"eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
12	"groupId": "{groupId}",
13	"hostId": "{hostId}",
14	"hostname": "db.example.com",
15	"id": "{globalAlertId}",
16	"isGlobalAdmin": false,
17	"maintenanceWindowId": "{maintenanceWindowId}",
18	"metricName": "OPCOUNTER_CMD",
19	"orgId": "{orgId}",
20	"port": 27017,
21	"remoteAddress": "192.168.1.1",
22	"replicaSetName": "rs1",
23	"shardName": "sh1",
24	"userId": "{userId}",
25	"username": "john.doe@example.com",
26	"targetUsername": "jane.doe@example.com",
27	"teamId": "{teamId}"
28	}