모든 프로젝트 이벤트 가져오기
필수 역할
이 리소스 를 성공적으로 호출하려면 API 키에 Project Read Only
역할 이 있어야 합니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /groups/{groupId}/events
요청 경로 매개변수
이름 | 유형 | 설명 |
---|---|---|
groupId | 문자열 | 원하는 이벤트와 연결된 프로젝트의 고유 식별자입니다. |
요청 쿼리 매개변수
고유 쿼리 매개변수
이 엔드포인트는 반환된 이벤트를 필터링하기 위해 다음 쿼리 매개변수를 허용합니다.
이름 | 유형 | 설명 | 기본값 |
---|---|---|---|
eventType | 문자열 | 지정된 유형의 이벤트만 반환합니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요. | |
includeRaw | 부울 | 출력에 중요
| false |
minDate | 문자열 | 생성된 날짜가 ISO 8601 의 지정된 타임스탬프보다 크거나 같은 이벤트만반환합니다. UTC 의 날짜 및 시간 형식입니다. | |
maxDate | 문자열 | 생성된 날짜가 ISO 8601 의 지정된 타임스탬프보다 작거나 같은 이벤트만 반환합니다. UTC 의 날짜 및 시간 형식입니다. |
일반 쿼리 매개변수
이 엔드포인트는 또한 값 목록을 반환하는 모든 엔드포인트에 공통된 쿼리 매개변수를 허용합니다.
이름 | 유형 | 설명 | 기본값 | ||||
---|---|---|---|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. | 1 | ||||
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 | ||||
pretty | 부울 | 응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타냅니다. | false | ||||
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 이벤트입니다.
이름 | 유형 | 설명 |
---|---|---|
alertId | 문자열 | 이 이벤트와 연결된 경고의 고유 식별자입니다. |
alertConfigId | 문자열 | alertId 와 연결된 경고 구성의 고유 식별자입니다. |
apiKeyId | 문자열 | 이 이벤트를 트리거한 API 키 의 고유 식별자입니다. 이 필드가 응답에 있는 경우 Ops Manager는 |
clusterId | 문자열 | 이 이벤트가 적용되는 cluster의 고유 식별자입니다. |
clusterName | 문자열 | 이 이벤트가 적용되는 cluster의 이름입니다. |
컬렉션 | 문자열 | 이벤트가 발생한 collection의 이름입니다. 이 필드는 eventTypeName 가 DATA_EXPLORER 또는 DATA_EXPLORER_CRUD 일 때 존재할 수 있습니다. |
생성됨 | 문자열 | ISO 8601 의 타임스탬프 이 이벤트가 트리거된 시점의 UTC 날짜 및 시간 형식입니다. |
currentValue | 객체 | 이 이벤트를 트리거한 지표의 현재 값입니다. |
currentValue .number | 숫자 | 지표의 값입니다. |
currentValue .units | 문자열 | 값의 관련 단위입니다. 예시메모리 소비를 측정하는 지표에는 바이트 측정값이 있고, 시간을 측정하는 지표에는 시간 단위가 있습니다. 허용되는 값은 다음과 같습니다.
|
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 | 문자열 | 이 리소스에 대한 변경 사항의 특성입니다.
|
diffs .type | 문자열 | 변경이 적용된 리소스입니다.
|
eventTypeName | 문자열 | 이 이벤트를 트리거한 상황의 이름입니다. 경고를 생성하는 이벤트 유형을 검토하려면 경고 유형을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요. |
groupId | 문자열 | 이 이벤트가 발생한 프로젝트의 고유 식별자입니다. |
hostId | 문자열 | 이 이벤트가 발생한 호스트의 고유 식별자입니다. |
호스트 이름 | 문자열 | 이벤트가 발생한 호스트의 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소입니다. |
id | 문자열 | 이 이벤트의 고유 식별자입니다. |
isGlobalAdmin | 부울 | 이 이벤트를 트리거한 사용자에게 Global Monitoring Administrator 역할이 있는지 여부를 나타내는 플래그입니다. |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 |
metricName | 문자열 | 값이 임계값을 벗어난 측정값의 이름입니다. |
opType | 문자열 | 이벤트를 생성한 작업 유형입니다. 이 필드는 eventTypeName 가 DATA_EXPLORER 또는 DATA_EXPLORER_CRUD 일 때 표시됩니다. |
포트 | integer | 이 이벤트와 관련된 호스트의 포트입니다. |
publicKey | 문자열 | 이 이벤트를 트리거한 API 키 와 연결된 공개 키입니다. 이 필드가 응답에 있는 경우 Ops Manager는 |
원시 | 문서 | 이벤트에 대한 추가 메타 정보입니다. 이 필드는 중요
|
원격 주소 | 문자열 | 이벤트를 트리거한 Ops Manager 사용자(userId)와 연결된 IP 주소입니다. |
복제본 세트 이름 | 문자열 | 복제본 세트의 이름입니다. |
shardName | 문자열 | 이벤트와 연결된 샤드의 이름입니다. |
targetPublicKey | 문자열 | 이벤트의 대상이 되는 API 키 의 공개 키입니다. |
targetUsername | 문자열 | 이 이벤트의 대상이 되는 Ops Manager 사용자의 사용자 이름입니다. |
teamId | 문자열 | 이 이벤트와 연결된 Ops Manager 팀의 고유 식별자입니다. |
userId | 문자열 | 이 이벤트를 트리거한 Ops Manager 사용자의 고유 식별자입니다. 이 필드가 응답에 있는 경우 Ops Manager는 |
사용자 이름 | 문자열 | 이 이벤트를 트리거한 Ops Manager 사용자의 사용자 이름입니다. 이 필드가 응답에 있는 경우 Ops Manager는 |
accessListEntry | 문자열 | 이벤트의 대상이 되는 API 키의 액세스 목록 항목입니다. |
요청 예시
curl --user "{publicKey}:{privateKey}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{groupId}/events?pretty=true"
응답 예시
응답 헤더
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 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 }, { 6 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events?pretty=true&itemsPerPage=100&pageNum=2", 7 "rel" : "next" 8 } ], 9 "results" : [ { 10 "created" : "2020-07-13T21:28:37Z", 11 "diffs" : [ { 12 "id" : "admin@admin", 13 "name" : null, 14 "params" : [ { 15 "display" : "Added Privilege", 16 "new" : "config.system.sessions: moveChunk", 17 "old" : null, 18 "param" : "config.system.sessions: moveChunk" 19 }, { 20 "display" : "Added Privilege", 21 "new" : "config.system.sessions: splitChunk", 22 "old" : null, 23 "param" : "config.system.sessions: splitChunk" 24 }, { 25 "display" : "Added Privilege", 26 "new" : "config.system.sessions: splitVector", 27 "old" : null, 28 "param" : "config.system.sessions: splitVector" 29 } ], 30 "priviileges" : [ { 31 "actions" : [ "moveChunk" ], 32 "resource" : { 33 "collection" : "system.sessions", 34 "db" : "config" 35 } 36 }, { 37 "actions" : [ "moveChunk" ], 38 "resource" : { 39 "collection" : "", 40 "db" : "" 41 } 42 }, { 43 "actions" : [ "enableSharding" ], 44 "resource" : { 45 "cluster" : true 46 } 47 }, { 48 "actions" : [ "cleanupOrphaned" ], 49 "resource" : { 50 "cluster" : true 51 } 52 }, { 53 "actions" : [ "flushRouterConfig" ], 54 "resource" : { 55 "cluster" : true 56 } 57 }, { 58 "actions" : [ "splitChunk" ], 59 "resource" : { 60 "collection" : "system.sessions", 61 "db" : "config" 62 } 63 }, { 64 "actions" : [ "splitChunk" ], 65 "resource" : { 66 "collection" : "", 67 "db" : "" 68 } 69 }, { 70 "actions" : [ "splitVector" ], 71 "resource" : { 72 "collection" : "system.sessions", 73 "db" : "config" 74 } 75 }, { 76 "actions" : [ "viewRole" ], 77 "resource" : { 78 "collection" : "", 79 "db" : "" 80 } 81 } ], 82 "roles" : [ { 83 "db" : "admin", 84 "role" : "readWriteAnyDatabase" 85 }, { 86 "db" : "admin", 87 "role" : "dbAdminAnyDatabase" 88 }, { 89 "db" : "admin", 90 "role" : "enableSharding" 91 }, { 92 "db" : "admin", 93 "role" : "backup" 94 }, { 95 "db" : "admin", 96 "role" : "clusterMonitor" 97 } ], 98 "status" : "MODIFIED", 99 "type" : "ROLES" 100 }, { 101 "id" : "sample-dataset-load@admin", 102 "name" : null, 103 "params" : [ ], 104 "priviileges" : null, 105 "roles" : [ { 106 "db" : "admin", 107 "role" : "readWriteAnyDatabase" 108 } ], 109 "status" : "NEW", 110 "type" : "USERS" 111 }, { 112 "id" : "10.16.0.6482-1", 113 "name" : null, 114 "params" : [ { 115 "display" : "Version", 116 "new" : "10.16.0.6482-1", 117 "old" : "10.12.0.6179-1", 118 "param" : "version" 119 } ], 120 "status" : "MODIFIED", 121 "type" : "AUTOMATION_AGENT" 122 } ], 123 "eventTypeName" : "AUTOMATION_CONFIG_PUBLISHED_AUDIT", 124 "groupId" : "{groupId}", 125 "id" : "{eventId}", 126 "isGlobalAdmin" : false, 127 "links" : [ { 128 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{groupId}/events/{eventId}", 129 "rel" : "self" 130 } ] 131 }], 132 "totalCount" : 1 133 }