경고 구성 활성화/비활성화

이 페이지의 내용

Resource

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

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

참고

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

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}

참고

이 엔드포인트는 경고 구성에 대한 활성화/비활성화 상태만 업데이트합니다. 이 구성보다 더 많은 구성을 업데이트하려면 경고 구성 업데이트를 참조하세요.

요청 경로 매개변수

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

Parameter	유형	설명
프로젝트 ID	문자열	이 프로젝트의 고유 식별자입니다.
ALERT-CONFIG-ID	문자열	이 경고 구성의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

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

false

요청 본문 매개변수

모든 요청 본문 매개변수는 필수 입니다.

Parameter	유형	설명
활성화됨	부울	활성화하려면 `true` 를 지정합니다. `false` 을 눌러 비활성화합니다.

응답

참고

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

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

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Content-Type: application/json' \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/alertConfigs/{ALERT-CONFIG-ID}" \
     --data '
       {
         "enabled" : false
       }'

응답 예시

응답 헤더

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:52:29Z",
  "enabled" : false,
  "groupId" : "{PROJECT-ID}",
  "id" : "{ALERT-CONFIG-ID}",
  "links" : [],
  "matchers" : [ {
    "fieldName" : "REPLICA_SET_NAME",
    "operator" : "EQUALS",
    "value" : "rs1"
  } ],
  "notifications" : [ {
    "delayMin" : 5,
    "emailAddress" : "sos@example.com",
    "intervalMin" : 60,
    "typeName" : "EMAIL"
  }, {
    "delayMin" : 60,
    "emailEnabled" : false,
    "intervalMin" : 120,
    "smsEnabled" : true,
    "typeName" : "GROUP"
  } ],
  "updated" : "2014-04-23T14:52:29Z"
}

돌아가기

Update

삭제