경고 구성 만들기

이 페이지의 내용

Resource

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

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

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

Resource

POST /groups/{PROJECT-ID}/alertConfigs

요청 경로 매개변수

모든 요청 경로 매개변수는 필수 입니다.

Parameter	유형	설명
프로젝트 ID	문자열	이 프로젝트의 고유 식별자입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

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

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

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

false

요청 본문 매개변수

참고

경고 구성은 다양합니다. 경고 구성에는 이러한 요소의 하위 집합만 포함될 수 있습니다.

이름	유형	설명
활성화됨	부울	생략하면 구성이 비활성화됩니다.
eventTypeName Required.	문자열	경고를 트리거하는 이벤트 유형입니다. 값에는 다음이 포함됩니다. 에이전트 `AUTOMATION_AGENT_DOWN` `AUTOMATION_AGENT_UP` `BACKUP_AGENT_CONF_CALL_FAILURE` `BACKUP_AGENT_DOWN` `BACKUP_AGENT_UP` `BACKUP_AGENT_VERSION_BEHIND` `BACKUP_AGENT_VERSION_CURRENT` `MONITORING_AGENT_DOWN` `MONITORING_AGENT_UP` `MONITORING_AGENT_VERSION_BEHIND` `MONITORING_AGENT_VERSION_CURRENT` `NEW_AGENT` 자동화 구성 `AUTOMATION_CONFIG_PUBLISHED_AUDIT` 백업 `BAD_CLUSTERSHOTS` `CLUSTER_BLACKLIST_UPDATED_AUDIT` `CLUSTER_CHECKKPOINT_UPDATED_AUDIT` `CLUSTER_CREDENTIAL_UPDATED_AUDIT` `CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `CLUSTER_STATE_CHANGED_AUDIT` `CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT` `CLUSTERSHOT_DELETED_AUDIT` `CLUSTERSHOT_EXPIRY_UPDATED_AUDIT` `CONSISTENT_BACKUP_CONFIGURATION` `GOOD_CLUSTERSHOT` `INCONSISTENT_BACKUP_CONFIGURATION` `INITIAL_SYNC_FINISHED_AUDIT` `INITIAL_SYNC_STARTED_AUDIT` `OPLOG_BEHIND` `OPLOG_CURRENT` `RESTORE_REQUESTED_AUDIT` `RESYNC_PERFORMED` `RESYNC_REQUIRED` `RS_BLACKLIST_UPDATED_AUDIT` `RS_CREDENTIAL_UPDATED_AUDIT` `RS_ROTATE_MASTER_KEY_AUDIT` `RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT` `RS_STATE_CHANGED_AUDIT` `RS_STORAGE_ENGINE_UPDATED_AUDIT` `SNAPSHOT_DELETED_AUDIT` `SNAPSHOT_EXPIRY_UPDATED_AUDIT` `SYNC_PENDING_AUDIT` `SYNC_REQUIRED_AUDIT` BI 커넥터 `BI_CONNECTOR_DOWN` `BI_CONNECTOR_UP` 클러스터 `CLUSTER_MONGOS_IS_MISSING` `CLUSTER_MONGOS_IS_PRESENT` `SHARD_ADDED` `SHARD_REMOVED` 액세스한 데이터 탐색기 `DATA_EXPLORER` `DATA_EXPLORER_CRUD` 호스트 `ADD_HOST_AUDIT` `ADD_HOST_TO_REPLICA_SET_AUDIT` `DELETE_HOST_AUDIT` `HOST_DOWN` `HOST_RECOVERING` `HOST_RESTARTED` `HOST_ROLLBACK` `HOST_SSL_CERTIFICATE_STALE` `OUTSIDE_METRIC_THRESHOLD` `REMOVE_HOST_FROM_REPLICA_SET_AUDIT` `UNDELETE_HOST_AUDIT` `VERSION_BEHIND` 조직 `ALL_ORG_USERS_HAVE_MFA` `ORG_API_KEY_ADDED` `ORG_API_KEY_DELETED` `ORG_EMPLOYEE_ACCESS_RESTRICTED` `ORG_EMPLOYEE_ACCESS_UNRESTRICTED` `ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED` `ORG_PUBLIC_API_ACCESS_LIST_REQUIRED` `ORG_RENAMED` `ORG_TWO_FACTOR_AUTH_OPTIONAL` `ORG_TWO_FACTOR_AUTH_REQUIRED` `ORG_USERS_WITHOUT_MFA` 프로젝트 `ALL_USERS_HAVE_MULTI_FACTOR_AUTH` `USERS_WITHOUT_MULTI_FACTOR_AUTH` 복제본 세트 `CONFIGURATION_CHANGED` `ENOUGH_HEALTHY_MEMBERS` `MEMBER_ADDED` `MEMBER_REMOVED` `MULTIPLE_PRIMARIES` `NO_PRIMARY` `ONE_PRIMARY` `PRIMARY_ELECTED` `TOO_FEW_HEALTHY_MEMBERS` `TOO_MANY_ELECTIONS` `TOO_MANY_UNHEALTHY_MEMBERS` 팀 `TEAM_ADDED_TO_GROUP` `TEAM_CREATED` `TEAM_DELETED` `TEAM_NAME_CHANGED` `TEAM_REMOVED_FROM_GROUP` `TEAM_ROLES_MODIFIED` `TEAM_UPDATED` `USER_ADDED_TO_TEAM` 사용자 `INVITED_TO_GROUP` `INVITED_TO_ORG` `JOIN_GROUP_REQUEST_APPROVED_AUDIT` `JOIN_GROUP_REQUEST_DENIED_AUDIT` `JOINED_GROUP` `JOINED_ORG` `JOINED_TEAM` `REMOVED_FROM_GROUP` `REMOVED_FROM_ORG` `REMOVED_FROM_TEAM` `REQUESTED_TO_JOIN_GROUP` `USER_ROLES_CHANGED_AUDIT` 경고를 생성하는 이벤트의 전체 목록과 해당 설명을 검토하려면 경고 유형 을 참조하세요. Ops Manager 감사 로그에 포함된 이벤트의 전체 목록은 감사 이벤트를 참조하세요.
matchers.fieldName	문자열	일치시킬 대상 객체의 필드 이름입니다. 호스트 경고는 이러한 필드를 지원합니다. `HOSTNAME` `PORT` `HOSTNAME_AND_PORT` `REPLICA_SET_NAME` `TYPE_NAME` 복제본 세트 경고는 이러한 필드를 지원합니다. `REPLICA_SET_NAME` `SHARD_NAME` `CLUSTER_NAME` Sharded cluster 경고는 다음과 같은 필드를 지원합니다. `CLUSTER_NAME` `SHARD_NAME` 다른 모든 유형의 경고는 매처를 지원하지 않습니다.
matchers.operator	문자열	필드 값을 테스트하는 연산자입니다. 허용되는 값은 다음과 같습니다. `EQUALS` `NOT_EQUALS` `CONTAINS` `NOT_CONTAINS` `STARTS_WITH` `ENDS_WITH` `REGEX`
matchers.value	문자열	지정된 연산자로 테스트할 값입니다. `matchers.fieldName` 로 설정된 `TYPE_NAME` 경우 다음 값을 일치시킬 수 있습니다. `PRIMARY` `SECONDARY` `STANDALONE` `CONFIG` `MONGOS`
matchers	객체 배열	이 경고 구성과 비교하여 객체를 일치시킬 때 적용할 규칙입니다. 이러한 모든 규칙과 일치하는 엔터티에 대해서만 경고 조건이 확인됩니다. `eventTypeName` 가 호스트, 복제본 세트 또는 샤드 cluster에 대한 이벤트를 지정하는 경우에만 `matchers` 배열을 사용하여 필터링할 수 있습니다.
metricThreshold.metricName	문자열	확인할 지표의 이름입니다. `alerts` 리소스의 `metricName` 필드와 동일한 값을 지원합니다.
metricThreshold.mode	문자열	이 지표의 평균을 계산하려면 `AVERAGE` 로 설정합니다.
metricThreshold.operator	문자열	임계값과 비교하여 현재 지표 값을 확인할 때 적용할 연산자입니다. 허용되는 값은 다음과 같습니다. `GREATER_THAN` `LESS_THAN`
metricThreshold.threshold	숫자	이 값을 벗어나면 경고가 트리거되는 임계값입니다.
metricThreshold.units	문자열	임계값의 단위입니다. 지표 유형에 따라 다릅니다. 예를 예시 메모리 소비를 측정하는 메트릭에는 바이트 측정이 있고 시간을 측정하는 메트릭에는 시간 단위가 있습니다. 허용되는 값은 다음과 같습니다. `RAW` `BITS` `BYTES` `KILOBITS` `KILOBYTES` `MEGABITS` `MEGABYTES` `GIGABITS` `GIGABYTES` `TERABYTES` `PETABYTES` `MILLISECONDS` `SECONDS` `MINUTES` `HOURS` `DAYS`
metricThreshold	객체	경고가 트리거되는 임계값입니다. `"eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"` 인 경우 필수입니다.
알림.apiToken	문자열	Slack API 토큰 또는 봇 토큰. `"notifications.typeName" : "SLACK"` 인 경우 필수입니다. 나중에 토큰이 유효하지 않게 되면 Ops Manager는 프로젝트 소유자에게 이메일을 보내고 결국 토큰을 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
알림.channelName	문자열	Slack 채널 이름입니다. `"notifications.typeName" : "SLACK"` 인 경우 필수입니다.
알림.datadogApiKey	문자열	DataDog API 키. DataDog 대시보드에 있습니다. `"notifications.typeName" : "DATADOG"` 인 경우 필수입니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
알림.delayMin	숫자	경고 조건이 감지된 후 첫 번째 알림을 보내기 전에 대기할 시간(분)입니다.
알림.이메일 주소	문자열	알림을 보낼 이메일 주소입니다. `"notifications.typeName" : "EMAIL"` 인 경우 필수입니다.
alerts.emailEnabled	부울	이메일 알림을 보낼지 여부를 결정합니다. 다음과 같은 경우 필수입니다. `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
alerts.intervalMin	숫자	해결되지 않은 승인되지 않은 경고에 대한 연속 알림 사이에 대기할 시간(분)입니다.
알림.webhookSecret	문자열	알림을 수락하고 전달하는 Webhook으로 인증하는 데 사용되는 값입니다. 다음 두 가지가 모두 포함된 요청에서만 시크릿을 명시적으로 선언할 수 있습니다. `notifications.typeName` `WEBHOOK` 명시적으로 선언된 `notifications.webhookURL` 통합 페이지 또는 통합 API를 통해서만 기본 `webhookURL` 에 대한 `webhookSecret` 를 구성할 수 있습니다. `webhookSecret` `webhookURL` 를 명시적으로 선언하려면 이 필드를 생략합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
알림.webhookUrl	문자열	이 알림을 Atlas Triggers 웹훅의 URL 입니다. `webhookUrl` 를 명시적으로 선언하지 않으면 요청은 통합 페이지 또는 통합 API와 함께 설정된 기본 `webhookUrl` 을 사용합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
알림.microsoftTeamsWebhookUrl	문자열	Microsoft 팀 채널 수신 웹훅 URL입니다. `"notifications.typeName" : "MICROSOFT_TEAMS"` 인 경우 필수입니다. 웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다.
알림.모바일 번호	문자열	SMS 메시지를 보낼 휴대폰 번호입니다. `"notifications.typeName" : "SMS"` 인 경우 필수입니다.
알림.notificationToken	문자열	HipChat API 토큰입니다. `"notifications.typeName" : "HIP_CHAT"` 인 경우 필수입니다. 나중에 토큰이 유효하지 않게 되면 Ops Manager는 프로젝트 소유자에게 이메일을 보내고 결국 토큰을 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
alerts.role	문자열	현재 프로젝트의 운영 관리자 역할입니다. `"notifications.typeName" : "GROUP"` 인 경우 필수입니다.
알림.roomName	문자열	HipChat 채팅방 이름입니다. `"notifications.typeName" : "HIP_CHAT"` 인 경우 필수입니다.
알림.serviceKey	문자열	PagerDuty 통합 키입니다. `"notifications.typeName" : "PAGER_DUTY"` 인 경우 필수입니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
알림.smsEnabled	부울	SMS 알림을 전송해야 함을 나타내는 플래그입니다. 다음과 같은 경우 필수입니다. `"notifications.typeName" : "GROUP"` `"notifications.typeName" : "USER"`
알림.teamId	문자열	팀의 고유 식별자입니다.
알림.typeName	문자열	경고 알림의 유형입니다. 허용되는 값은 다음과 같습니다. `DATADOG` `EMAIL` `GROUP` (프로젝트) `HIPCHAT` `ORG` `PAGER_DUTY` `SLACK` `SMS` (Twilio 통합 을 구성해야 함) `USER` `WEBHOOK`
알림.사용자 이름	문자열	알림을 보낼 Ops Manager 사용자의 이름입니다. 경고 구성을 소유한 프로젝트의 사용자를 지정합니다. `"notifications.typeName" : "USER"` 인 경우 필수입니다.
notifications Required	객체 배열	경고 조건이 감지되면 전송할 알림입니다.
임계값.연산자	문자열	임계값과 비교하여 현재 지표 값을 확인할 때 적용할 연산자입니다. `GREATER_THAN` `LESS_THAN`
임계값.임계값	숫자	이 값을 벗어나면 경고가 트리거되는 임계값입니다.
임계값	객체	경고가 트리거되는 임계값입니다. 다음과 같은 경우 필수입니다. `"eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"` `"eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS`

응답

응답에는 경고 구성 세부 정보가 포함됩니다.

참고

경고 구성은 다양합니다. 경고 구성에는 이러한 요소의 하위 집합만 포함될 수 있습니다.

이름	유형	설명
생성됨	문자열	ISO 8601 의 타임스탬프 이 경고 구성이 생성된 시점의 UTC 날짜 및 시간 형식입니다.
활성화됨	부울	이 경고 구성이 활성화되었음을 나타내는 플래그입니다.
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가 알림을 보낼 하나 이상의 대상입니다.
notifications.[n] .apiToken	문자열	Slack API 토큰 토큰. `notifications.[n].typeName` 을 `SLACK` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .channelName	문자열	Slack 채널 이름입니다. `notifications.[n].typeName` 을 `SLACK` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .datadogApiKey	문자열	DataDog API 키. `notifications.[n].typeName` 을 `DATADOG` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .delayMin	숫자	경고 조건이 감지된 후 첫 번째 알림을 보내기 전에 대기할 시간(분)입니다.
notifications.[n] .emailAddress	문자열	알림을 보낼 이메일 주소입니다. `notifications.[n].typeName` 을 `EMAIL` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .emailEnabled	부울	이메일 알림을 보내야 함을 나타내는 플래그입니다. Ops Manager는 `notifications.[n].typeName` 을 `ORG`, `GROUP` 또는 `USER` 로 설정한 경우 이 값을 반환합니다.
notifications.[n] .intervalMin	숫자	해결되지 않은 승인되지 않은 경고에 대한 연속 알림 사이에 대기할 시간(분)입니다.
notifications.[n] .microsoftTeamsWebhookUrl	문자열	Microsoft 팀 채널 수신 웹훅 URL입니다. `notifications.[n].typeName` 을 `MICROSOFT_TEAMS` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. 웹후크 알림에 대한 경고를 보거나 편집할 때 URL은 부분적으로 편집된 상태로 표시되고 비밀번호는 완전히 편집된 상태로 표시됩니다.
notifications.[n] .mobileNumber	문자열	경고 알림이 전송될 휴대폰 번호입니다. `notifications.[n].typeName` 을 `SMS` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .notificationToken	문자열	HipChat API 토큰. `notifications.[n].typeName` 을 `HIP_CHAT` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. 나중에 토큰이 유효하지 않게 되면 MongoDB Atlas는 `Project Owner` (으)로 이메일을 보내고 결국 토큰을 제거합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .opsGenieApiKey	문자열	OpsGenie 경고 API 키. MongoDB Ops Manager는 `notifications.[n].typeName` 를 `OPS_GENIE` 로 설정한 경우 이 값을 반환합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .opsGenieRegion	문자열	사용할 API URL 을 나타내는 리전입니다. `notifications.[n].typeName` 를 `OPS_GENIE` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .roles	문자열 배열	현재 프로젝트 또는 조직의 Ops Manager 역할. `notifications.[n].typeName` 을 `ORG` 또는 `GROUP` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .roomName	문자열	HipChat 채팅방 이름입니다. `"notifications.typeName" : "HIP_CHAT` 인 경우 Ops Manager가 이 값을 반환합니다.
notifications.[n] .serviceKey	문자열	PagerDuty 서비스 키입니다. `notifications.[n].typeName` 을 `PAGER_DUTY` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .smsEnabled	부울	텍스트 알림을 보내야 함을 나타내는 플래그입니다. Ops Manager는 `notifications.[n].typeName` 을 `ORG`, `GROUP` 또는 `USER` 로 설정한 경우 이 값을 반환합니다.
notifications.[n] .teamId	문자열	이 알림을 수신하는 팀의 고유 식별자입니다.
notifications.[n] .teamName	문자열	이 알림을 수신하는 팀의 레이블입니다.
notifications.[n] .typeName	문자열	Ops Manager가 경고에 대한 알림을 보내도록 하는 수단입니다.
notifications.[n] .username	문자열	알림을 보낼 Ops Manager 사용자의 이름입니다. `notifications.[n].typeName` 을 `USER` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .victorOpsApiKey	문자열	VictorOps API 키입니다. 나중에 키가 유효하지 않게 되면 MongoDB Atlas는 `Project Owner` (으)로 이메일을 보내고 결국 키를 제거합니다. `notifications.[n].typeName` 을 `VICTOR_OPS` 로 설정한 경우 Ops Manager는 이 값을 반환합니다. API 또는 통합 키가 필요한 타사 통합을 생성한 후 다음과 같은 경우 키가 부분적으로 편집된 상태로 표시됩니다. UI를 통해 경고를 보거나 편집합니다. API 를 통해 타사 통합 설정을 쿼리합니다.
notifications.[n] .victorOpsRoutingKey	문자열	VictorOps 라우팅 키입니다. 나중에 키가 유효하지 않게 되면 MongoDB Atlas는 `Project Owner` (으)로 이메일을 보내고 결국 키를 제거합니다. `notifications.[n].typeName` 을 `VICTOR_OPS` 로 설정한 경우 Ops Manager는 이 값을 반환합니다.
notifications.[n] .webhookSecret	문자열	알림을 수락하고 전달하는 Webhook으로 인증하는 데 사용되는 값입니다. Ops Manager는 `notifications.[n].typeName` 을(를) `WEBHOOK` (으)로 설정하거나 다음 중 하나에 해당하는 경우 이 값을 반환합니다. `notification.[n].webhookSecret` 을(를) 비어 있지 않은 문자열로 설정합니다. 통합 페이지 또는 통합 API를 사용하여 기본 `webhookSecret` 를 설정합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
notifications.[n] .webhookUrl	문자열	이 알림을 Atlas Triggers 웹훅의 URL 입니다. Ops Manager는 `notifications.[n].typeName` 을(를) `WEBHOOK` (으)로 설정하거나 다음 중 하나에 해당하는 경우 이 값을 반환합니다. `notification.[n].webhookURL` 을(를) 비어 있지 않은 문자열로 설정합니다. 통합 페이지 또는 통합 API를 사용하여 기본 `webhookUrl` 를 설정합니다. 웹훅 알림을 생성한 후 경고 를 보거나 편집할 때 URL 이 부분적으로 수정되고 시크릿은 완전히 수정됩니다.
임계값	객체	경고를 트리거하는 임계값입니다. Ops Manager는 `eventTypeName` 이 `OUTSIDE_METRIC_THRESHOLD` 이외의 값인 경우 이 값을 반환합니다.
threshold .operator	문자열	Ops Manager가 임계값과 비교하여 현재 메트릭 값을 확인할 때 적용한 비교 연산자입니다.
threshold .threshold	숫자	초과 시 Ops Manager가 Atlas Triggers하는 값입니다.
threshold .units	문자열	`threshold.threshold` 의 범위를 정의하는 용량 또는 시간 단위입니다.
typeName	문자열	이 필드는 더 이상 사용되지 않으며 무시됩니다.
Updated	문자열	ISO 8601 의 타임스탬프 이 경고 구성이 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request POST "https://<ops-manager-host>/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs" \
 --data '
   {
     "eventTypeName" : "RESYNC_REQUIRED",
     "enabled" : true,
     "notifications" : [ {
       "typeName" : "GROUP",
       "intervalMin" : 5,
       "delayMin" : 0,
       "smsEnabled" : false,
       "emailEnabled" : 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}

응답 본문

{
  "created" : "2014-04-23T14:29:18Z",
  "enabled" : true,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ ],
  "notifications" : [ {
    "delayMin" : 0,
    "emailEnabled" : true,
    "intervalMin" : 5,
    "smsEnabled" : false,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:29:18Z"
}

돌아가기

프로젝트에 대한 모든 경고 구성 가져오기

경고 구성 가져오기