프로젝트에 대한 모든 경고 구성 가져오기
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
리소스
GET /groups/{PROJECT-ID}/alertConfigs
요청 경로 매개변수
모든 요청 경로 매개변수는 필수 입니다.
매개변수 | 유형 | 설명 |
|---|---|---|
프로젝트 ID | 문자열 | 이 프로젝트의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. | 1 |
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | 옵션 | false | |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 | false |
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다. | true |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다.URL 간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 경고 구성입니다.
참고
경고 구성은 다양합니다. 경고 구성에는 이러한 요소의 하위 집합만 포함될 수 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
생성됨 | 문자열 | ISO 8601 의 타임스탬프 이 경고 구성이 생성된 시점의 UTC 날짜 및 시간 형식입니다. |
enabled | 부울 | 이 경고 구성이 활성화되었음을 나타내는 플래그입니다. |
eventTypeName | 문자열 | Atlas Triggers 이벤트 유형입니다. |
groupId | 문자열 | 이 경고 구성을 소유한 프로젝트의 고유 식별자입니다. |
id | 문자열 | 경고 구성의 고유 식별자입니다. |
링크 | 객체 배열 | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. URL 간의 관계 유형은 웹 링크 사양 에 설명되어 있습니다. . |
matchers | 객체 배열 | 이 경고 구성과 비교하여 객체를 일치시킬 때 적용할 규칙입니다. |
matchers .[n].fieldName | 문자열 | 이 구성과 일치시키려는 대상 객체의 필드 이름입니다. |
matchers .[n].operator | 문자열 | matcher.[n].value 에 대해 현재 지표 값을 확인할 때 적용할 비교 연산자입니다. |
matchers .[n].value | 문자열 | matchers.[n].operator 을(를) 사용하여 일치하거나 초과하는 값입니다. |
metricThreshold | 객체 | 경고를 트리거하는 값과 비교 수단입니다. |
metricThreshold .metricName | 문자열 | 확인할 지표의 이름입니다. alerts 리소스의 metricName 필드와 동일한 값을 지원합니다. |
metricThreshold .mode | 문자열 | 이 지표의 평균값입니다. |
metricThreshold .operator | 문자열 | Ops Manager가 임계값과 비교하여 현재 메트릭 값을 확인할 때 적용한 비교 연산자입니다. |
metricThreshold .threshold | 숫자 | Atlas Triggers 시 경고를 초과하는 metricThreshold.metricName 값입니다. |
metricThreshold .units | 문자열 | metricThreshold.threshold 의 범위를 정의하는 용량 또는 시간 단위입니다. |
notifications | 객체 배열 | 경고 조건이 감지되면 Ops Manager가 알림을 보낼 하나 이상의 대상입니다. |
알림.[n] .apiToken | 문자열 | Slack API 토큰 토큰. 참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .channelName | 문자열 | Slack 채널 이름입니다. notifications.[n].typeName 을 SLACK 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .datadogApiKey | 문자열 | DataDog API 키. 참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .delayMin | 숫자 | 경고 조건이 감지된 후 첫 번째 알림을 보내기 전에 대기할 시간(분)입니다. |
알림.[n] .emailAddress | 문자열 | 알림을 보낼 이메일 주소입니다. notifications.[n].typeName 을 EMAIL 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .emailEnabled | 부울 | 이메일 알림을 보내야 함을 나타내는 플래그입니다. Ops Manager는 notifications.[n].typeName 을 ORG, GROUP 또는 USER 로 설정한 경우 이 값을 반환합니다. |
알림.[n] .intervalMin | 숫자 | 해결되지 않은 승인되지 않은 경고에 대한 연속 알림 사이에 대기할 시간(분)입니다. |
알림.[n] .microsoftTeamsWebhookUrl | 문자열 | Microsoft 팀 채널 수신 웹훅 URL입니다. 참고웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다. |
알림.[n] .MobileNumber | 문자열 | 경고 알림이 전송될 휴대폰 번호입니다. notifications.[n].typeName 을 SMS 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .notificationToken | 문자열 | HipChat API 토큰. 나중에 토큰이 유효하지 않게 되면 MongoDB Atlas는 참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .opsGenieApiKey | 문자열 | OpsGenie 경고 API 키. 를 로 설정한 경우 Ops Manager는 이 값을 참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .opsGenieRegion | 문자열 | 사용할 API URL 을 나타내는 리전입니다. notifications.[n].typeName 를 OPS_GENIE 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .roles | 문자열 배열 | 현재 프로젝트 또는 조직의 Ops Manager 역할. notifications.[n].typeName 을 ORG 또는 GROUP 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .roomName | 문자열 | HipChat 채팅방 이름입니다. "notifications.typeName" : "HIP_CHAT 인 경우 Ops Manager가 이 값을 반환합니다. |
알림.[n] .serviceKey | 문자열 | PagerDuty 서비스 키입니다. 참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .smsEnabled | 부울 | 텍스트 알림을 보내야 함을 나타내는 플래그입니다. Ops Manager는 notifications.[n].typeName 을 ORG, GROUP 또는 USER 로 설정한 경우 이 값을 반환합니다. |
알림.[n] .snmpAddress | 문자열 | SNMP 트랩을 보낼 호스트 이름 및 포트입니다. 현재 Ops Manager는 표준 SNMP 포트( )로만 SNMP 트랩을 보낼162 수 있습니다. 중요Ops Manager 6.0.0 는 SNMP 경고를 더 이상 사용하지 않습니다. Ops Manager 7.0.0 에는 SNMP 경고가 포함되지 않습니다. 다른 경고 옵션에 대해 자세히 알아보려면 타사 서비스 통합을 참조하세요. |
알림.[n] .teamId | 문자열 | 이 알림을 수신하는 팀의 고유 식별자입니다. |
알림.[n] .teamName | 문자열 | 이 알림을 수신하는 팀의 레이블입니다. |
알림.[n] .typeName | 문자열 | Ops Manager가 경고에 대한 알림을 보내도록 하는 수단입니다. |
알림.[n] .username | 문자열 | 알림을 보낼 Ops Manager 사용자의 이름입니다. notifications.[n].typeName 을 USER 로 설정한 경우 Ops Manager는 이 값을 반환합니다. |
알림.[n] .VictorOpsApiKey | 문자열 | VictorOps API 키입니다. 나중에 키가 유효하지 않게 되면 MongoDB Atlas는
참고API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다.
|
알림.[n] .VictorOpsRoutingKey | 문자열 | VictorOps 라우팅 키입니다. 나중에 키가 유효하지 않게 되면 MongoDB Atlas는
|
알림.[n] .webhookSecret | 문자열 | 알림을 수락하고 전달하는 Webhook으로 인증하는 데 사용되는 값입니다. Ops Manager는
참고웹훅 알림을 생성한 후 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀은 완전히 편집된 상태로 표시됩니다. |
알림.[n] .webhookUrl | 문자열 | |
임계값 | 객체 | 경고를 트리거하는 임계값입니다. Ops Manager는 eventTypeName 이 OUTSIDE_METRIC_THRESHOLD 이외의 값인 경우 이 값을 반환합니다. |
임계값 .operator | 문자열 | Ops Manager가 임계값과 비교하여 현재 메트릭 값을 확인할 때 적용한 비교 연산자입니다. |
임계값 .threshold | 숫자 | 초과 시 Ops Manager가 Atlas Triggers하는 값입니다. |
임계값 .units | 문자열 | threshold.threshold 의 범위를 정의하는 용량 또는 시간 단위입니다. |
typeName | 문자열 | 이 필드는 더 이상 사용되지 않으며 무시됩니다. |
Updated | 문자열 | ISO 8601 의 타임스탬프 이 경고 구성이 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다. |
요청 예시
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs"
응답 예시
응답 헤더
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}
응답 본문
{ "links" : [], "results": [ { "created" : "2013-10-30T15:28:30Z", "enabled" : true, "eventTypeName" : "RESYNC_REQUIRED", "groupId" : "{PROJECT-ID}", "id" : "5271259ee4b00ece6b4754ef", "links" : [], "matchers" : [ ], "notifications" : [ { "delayMin" : 0, "emailAddress" : "somebody@example.com", "intervalMin" : 60, "typeName" : "EMAIL" } ], "updated" : "2014-02-12T16:11:05Z" }, { "created" : "2014-03-19T16:42:07Z", "enabled" : true, "eventTypeName" : "MONITORING_AGENT_DOWN", "groupId" : "{PROJECT-ID}", "id" : "5329c8dfe4b0b07a83d67e7e", "links" : [], "matchers" : [ ], "notifications" : [ { "delayMin" : 0, "emailEnabled" : true, "intervalMin" : 5, "smsEnabled" : false, "typeName" : "GROUP" } ], "updated" : "2014-03-19T16:42:07Z" }, { "created" : "2014-04-03T20:26:50Z", "enabled" : true, "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD", "groupId" : "{PROJECT-ID}", "id" : "533dc40ae4b00835ff81eaee", "links" : [], "matchers" : [ { "field" : "hostnameAndPort", "operator" : "EQUALS", "value" : "mongo.example.com:27017" } ], "notifications" : [ { "delayMin" : 0, "intervalMin" : 5, "mobileNumber" : "2343454567", "typeName" : "SMS" } ], "metricThreshold" : { "metricName" : "ASSERT_REGULAR", "mode" : "AVERAGE", "operator" : "LESS_THAN", "threshold" : 99.0, "units" : "RAW" }, "updated" : "2014-04-03T20:26:50Z", } ], "totalCount": 3 }